Elgg  Version 2.3
ElggFilestore.php
Go to the documentation of this file.
1 <?php
9 abstract class ElggFilestore {
18  abstract public function open(\ElggFile $file, $mode);
19 
28  abstract public function write($f, $data);
29 
39  abstract public function read($f, $length, $offset = 0);
40 
49  abstract public function seek($f, $position);
50 
58  abstract public function eof($f);
59 
67  abstract public function tell($f);
68 
76  abstract public function close($f);
77 
85  abstract public function delete(\ElggFile $file, $follow_symlinks = true);
86 
94  abstract public function getFileSize(\ElggFile $file);
95 
103  abstract public function getFilenameOnFilestore(\ElggFile $file);
104 
111  abstract public function getParameters();
112 
120  abstract public function setParameters(array $parameters);
121 
129  abstract public function grabFile(\ElggFile $file);
130 
138  abstract public function exists(\ElggFile $file);
139 }
$mode
$mode
Configure site maintenance mode.
Definition: set_maintenance_mode.php:6
ElggFilestore\grabFile
grabFile(\ElggFile $file)
Get the contents of the whole file.
ElggFilestore\eof
eof($f)
Return a whether the end of a file has been reached.
ElggFilestore\write
write($f, $data)
Write data to a given file handle.
ElggFilestore\getFileSize
getFileSize(\ElggFile $file)
Return the size in bytes for a given file.
ElggFilestore\getFilenameOnFilestore
getFilenameOnFilestore(\ElggFile $file)
Return the filename of a given file as stored on the filestore.
ElggFilestore\setParameters
setParameters(array $parameters)
Set the parameters from the associative array produced by $this->getParameters().
ElggFilestore\seek
seek($f, $position)
Seek a given position within a file handle.
ElggFilestore\getParameters
getParameters()
Get the filestore's creation parameters as an associative array.
ElggFilestore\close
close($f)
Close a given file handle.
ElggFilestore\read
read($f, $length, $offset=0)
Read data from a filestore.
ElggFilestore\exists
exists(\ElggFile $file)
Return whether a file physically exists or not.
ElggFilestore\open
open(\ElggFile $file, $mode)
Attempt to open the file $file for storage or writing.
ElggFilestore\tell
tell($f)
Return the current position in an open file.
$position
$position
Definition: move.php:10
$data
$data
Definition: opendd.php:13
$length
$length
Definition: excerpt.php:14
$offset
if(! $count) $offset
Definition: pagination.php:26
$file
if(!array_key_exists($filename, $text_files)) $file
Definition: plugin_text_file.php:29
Generated on Fri Aug 29 2025 00:00:46 for Elgg by doxygen 1.9.1