Definition at line 9 of file ElggFilestore.php.
ElggFilestore::close |
( |
|
$f | ) |
|
|
abstract |
Close a given file handle.
- Parameters
-
- Returns
- bool
ElggFilestore::delete |
( |
\ElggFile |
$file, |
|
|
|
$follow_symlinks = true |
|
) |
| |
|
abstract |
Delete the file associated with a given file handle.
- Parameters
-
\ElggFile | $file | The file |
bool | $follow_symlinks | If true, will also delete the target file if the current file is a symlink |
- Returns
- bool
Return a whether the end of a file has been reached.
- Parameters
-
- Returns
- boolean
ElggFilestore::exists |
( |
\ElggFile |
$file | ) |
|
|
abstract |
Return whether a file physically exists or not.
- Parameters
-
- Returns
- bool
ElggFilestore::getFilenameOnFilestore |
( |
\ElggFile |
$file | ) |
|
|
abstract |
Return the filename of a given file as stored on the filestore.
- Parameters
-
- Returns
- string
ElggFilestore::getFileSize |
( |
\ElggFile |
$file | ) |
|
|
abstract |
Return the size in bytes for a given file.
- Parameters
-
- Returns
- int
ElggFilestore::getParameters |
( |
| ) |
|
|
abstract |
Get the filestore's creation parameters as an associative array.
Used for serialisation and for storing the creation details along side a file object.
- Returns
- array
ElggFilestore::grabFile |
( |
\ElggFile |
$file | ) |
|
|
abstract |
Get the contents of the whole file.
- Parameters
-
mixed | $file | The file handle. |
- Returns
- mixed The file contents.
ElggFilestore::open |
( |
\ElggFile |
$file, |
|
|
|
$mode |
|
) |
| |
|
abstract |
Attempt to open the file $file for storage or writing.
- Parameters
-
\ElggFile | $file | A file |
string | $mode | "read", "write", "append" |
- Returns
- mixed A handle to the opened file or false on error.
ElggFilestore::read |
( |
|
$f, |
|
|
|
$length, |
|
|
|
$offset = 0 |
|
) |
| |
|
abstract |
Read data from a filestore.
- Parameters
-
mixed | $f | The file handle |
int | $length | Length in bytes to read. |
int | $offset | The optional offset. |
- Returns
- mixed String of data or false on error.
ElggFilestore::seek |
( |
|
$f, |
|
|
|
$position |
|
) |
| |
|
abstract |
Seek a given position within a file handle.
- Parameters
-
mixed | $f | The file handle. |
int | $position | The position. |
- Returns
- int 0 for success, or -1
ElggFilestore::setParameters |
( |
array |
$parameters | ) |
|
|
abstract |
Set the parameters from the associative array produced by $this->getParameters().
- Parameters
-
array | $parameters | A list of parameters |
- Returns
- bool
ElggFilestore::tell |
( |
|
$f | ) |
|
|
abstract |
Return the current position in an open file.
- Parameters
-
- Returns
- int
ElggFilestore::write |
( |
|
$f, |
|
|
|
$data |
|
) |
| |
|
abstract |
Write data to a given file handle.
- Parameters
-
mixed | $f | The file handle - exactly what this is depends on the file system |
string | $data | The binary string of data to write |
- Returns
- int Number of bytes written.
The documentation for this class was generated from the following file: