Element index for package File
[ a ]
[ b ]
[ c ]
[ d ]
[ e ]
[ f ]
[ g ]
[ h ]
[ i ]
[ l ]
[ m ]
[ n ]
[ o ]
[ p ]
[ r ]
[ s ]
[ t ]
[ u ]
[ w ]
a
- $absolute
- in file File.php, variable File::$absolute
The absolute path to the file, including its name.
- $appendMode
- in file Store.php, variable FileStore::$appendMode
Sets the write mode to use in the append() method.
- $autoInit
- in file Store.php, variable FileStore::$autoInit
$autoInit determines whether you want to create the
- append
- in file Store.php, method FileStore::append()
Writes to the end of the specified file. Can be limited by the $length parameter. Handles opening and closing of the file automatically. Returns false on error, or the number of bytes written on success.
- append
- in file File.php, method File::append()
Append to the specified file (or the file contained in the $absolute property) with the specified $data.
top
b
- build
- in file Directory.php, method Dir::build()
Takes a directory path and builds each level if they don't exist.
- buildDirs
- in file Store.php, method FileStore::buildDirs()
Builds the recursive directory structure used by this package, stopping at the depth specified (called usually by init(), which uses the $depth property to determine this number).
top
c
- $content
- in file File.php, variable File::$content
Stores the content of the file after a call to contents().
- close
- in file Directory.php, method Dir::close()
Closes the current directory.
- contains
- in file File.php, method File::contains()
Opens a file and returns whether or not it contains a specified string or pattern. Can be called using the File::contains syntax, as well as through an instantiated object.
- contents
- in file File.php, method File::contents()
Returns the contents of the file as a string. If the $file is not specified, it uses the $absolute property of the current File object. Also stores it in the $content property so you don't have to read it from the file system twice.
- copy
- in file Store.php, method FileStore::copy()
Copies the specified $oldFile to the repository, under the name provided in the $file parameter.
- countAll
- in file Store.php, method FileStore::countAll()
Returns the total number of documents in the repository, as listed in the accompanying database table. A $prefix is optional. Returns false and sets $error on database error.
top
d
- $dbTable
- in file Store.php, variable FileStore::$dbTable
If the $dbTable is set, FileStore will use the
- $depth
- in file Store.php, variable FileStore::$depth
The number of levels deep the directory structure
- $description
- in file File.php, variable File::$description
The description of the file.
- $dirMode
- in file Store.php, variable FileStore::$dirMode
Sets the directory mode to use when calling mkdir() within buildDirs() and initDir(). Default is 0755.
- determine
- in file File.php, method File::determine()
Selects the first file that exists from the specified list.
- Dir
- in file Directory.php, class Dir
Dir is basically a wrapper class around PHP's internal Directory
- Dir
- in file Directory.php, method Dir::Dir()
Constructor method. Opens the specified directory if one is provided.
- Directory.php
- procedural page Directory.php
top
e
- $error
- in file Store.php, variable FileStore::$error
Contains the error message if one occurs within FileStore.
- $extension
- in file File.php, variable File::$extension
The file's extension (ie. the extension of 'file.gif' is 'gif').
- exists
- in file Store.php, method FileStore::exists()
Determines whether a file exists within the storage system or not.
top
f
- $filemtime
- in file File.php, variable File::$filemtime
The actual value returned by the filemtime() call on this file.
- $filesize
- in file File.php, variable File::$filesize
The actual size of this file in bytes.
- $formatted_perms
- in file File.php, variable File::$formatted_perms
The permissions of the file formatted by the formatPerms() method.
- fetch
- in file Directory.php, method Dir::fetch()
Fetches all the files in a directory in a single command, ie. $files = Dir::fetch ('foo/bar');
- File
- in file File.php, class File
File is a simple class to keep basic file information gathering structured and readable. Stores everything as a property of the class instead of as methods, so that it integrates easily with the Template class.
- File
- in file File.php, method File::File()
Constructor method. $abs_file_path is the absolute directory path to the file, including its name. $www_file_path is the path from the web document root to same, minus the file name.
- FileStore
- in file Store.php, method FileStore::FileStore()
Constructor method.
- FileStore
- in file Store.php, class FileStore
FileStore implements a directory layout that allows for higher performance filesystem access on very large document collections.
- file_append
- in file File.php, function file_append()
Append to the specified file (or the file contained in the $absolute property) with the specified $data.
- file_determine
- in file File.php, function file_determine()
Alias of File::determine(). Returns the first file that exists from the specified list.
- File.php
- procedural page File.php
- file_overwrite
- in file File.php, function file_overwrite()
Overwrite the specified file (or the file contained in the $absolute property) with the specified $data.
- file_rand
- in file File.php, function file_rand()
Alias of File::rand(). Returns a random file from the specified directory.
- find
- in file Directory.php, method Dir::find()
Searches a directory or directories (recursively) for a file that matches a given pattern.
- findInFiles
- in file Directory.php, method Dir::findInFiles()
Searches a directory or directories (recursively) for a file that contains a given string or pattern. Note: this method requires the saf.File class.
- find_in_files
- in file Directory.php, method Dir::find_in_files()
Deprecated. Use findInFiles() instead.
- formatPerms
- in file File.php, method File::formatPerms()
Reads an octal mode value and returns a string of the
- format_filesize
- in file File.php, method File::format_filesize()
Formats the size of the file into a string appropriate for human consumption.
top
g
- $gid
- in file File.php, variable File::$gid
The group id of the file.
- $group
- in file File.php, variable File::$group
The group name of the file. Not available if PHP is running in safe_mode.
- get
- in file Store.php, method FileStore::get()
Reads from the specified file, either in entirety, or to the specified length. Handles opening and closing of the file automatically. Returns false on error.
- getPath
- in file Store.php, method FileStore::getPath()
Gets the absolute path to the file requested.
- getStruct
- in file Directory.php, method Dir::getStruct()
Returns the "structure" of the filesystem below the specified path.
top
h
- $handle
- in file Directory.php, variable Dir::$handle
Contains the handle of the currently open directory.
top
i
- $icon
- in file File.php, variable File::$icon
An icon to help describe the file visually.
- $ignoreChars
- in file Store.php, variable FileStore::$ignoreChars
The number of characters to ignore at the beginning
- $is_dir
- in file File.php, variable File::$is_dir
Determines whether or not this file is a directory.
- $is_writeable
- in file File.php, variable File::$is_writeable
Determines whether or not this file is writeable by the current script.
- init
- in file Store.php, method FileStore::init()
Initializes the storage location by ensuring that
top
l
- $last_modified
- in file File.php, variable File::$last_modified
The date and time the file was last modified, in a formatted string.
- listAll
- in file Store.php, method FileStore::listAll()
Searches for a list of files within the repository
top
m
- matches
- in file Directory.php, method Dir::matches()
Compares a file name to a pattern string, which may contain simple * wildcards.
- move
- in file Store.php, method FileStore::move()
Moves the specified $oldFile to the repository, under the name provided in the $file parameter. If $isUploaded is true, then it uses the move_uploaded_file() function instead of the rename() function.
top
n
- $name
- in file File.php, variable File::$name
The file's name.
top
o
- $owner
- in file File.php, variable File::$owner
The owner name of the file. Not available if PHP is running in safe_mode.
- open
- in file Directory.php, method Dir::open()
Opens the specified directory.
- open
- in file Store.php, method FileStore::open()
Opens a file within the system for writing. Note that this method does not synchronize a newly created file with the $dbTable. For that, use the get() and remove() methods.
- overwrite
- in file File.php, method File::overwrite()
Overwrite the specified file (or the file contained in the $absolute property) with the specified $data.
top
p
- $path
- in file Directory.php, variable Dir::$path
Contains the path provided to the currently open directory.
- $path
- in file File.php, variable File::$path
The web path to the file, beginning from the document root.
- $path
- in file Store.php, variable FileStore::$path
The path to the root of the file store. Default is empty.
- $perms
- in file File.php, variable File::$perms
The octal permissions of the file.
- put
- in file Store.php, method FileStore::put()
Writes to the specified file, either in entirety, or to the specified length. Handles opening and closing of the file automatically. Returns false on error, or the number of bytes written on success.
top
r
- $readMode
- in file Store.php, variable FileStore::$readMode
Sets the write mode to use in the get() method.
- rand
- in file File.php, method File::rand()
Select a random file from the specified directory. The $ext is an optional extension, or array of extensions, to limit the selection to. Also automatically eliminates dot-files and folders.
- read
- in file Directory.php, method Dir::read()
Read the contents of the directory and return them one at a time.
- readAll
- in file Directory.php, method Dir::readAll()
Read and sort the contents of the directory and return them as an array.
- read_all
- in file Directory.php, method Dir::read_all()
Deprecated. Use readAll() instead.
- remove
- in file Store.php, method FileStore::remove()
Deletes a file from the storage system.
- rewind
- in file Directory.php, method Dir::rewind()
Rewinds the internal cursor for the purpose of re-reading the directory contents.
- rmdirRecursive
- in file Directory.php, method Dir::rmdirRecursive()
Removes a directory and all of its contents.
- rmdir_recursive
- in file Directory.php, method Dir::rmdir_recursive()
Deprecated. Use rmdirRecursive() instead.
top
s
- $size
- in file File.php, variable File::$size
The size of the file in a formatted string.
- Store.php
- procedural page Store.php
top
t
- $type
- in file File.php, variable File::$type
Type can be either 'ascii', 'binary', or 'folder'. Sitellite treats files differently depending on their type.
top
u
- $uid
- in file File.php, variable File::$uid
The user id of the file.
- $useMD5
- in file Store.php, variable FileStore::$useMD5
If the file names are all very similar, and
top
w
- $writeMode
- in file Store.php, variable FileStore::$writeMode
Sets the write mode to use in the put() method.
top
|
|
Sitellite Application Framework
