Class FileSystemResource
Description
«abstract» filesystem resource
This is an abstract super-class for all filesystem wrappers.
For examples: resources may be files of any type, or directories.
All subclasses should implement the abstract functions read() and isEmpty(). You are also encouraged to re-implement the function toString().
Object | --FileSystemResource
Method Summary
- FileSystemResource FileSystemResource (string $filename)
- bool equals (object $anotherObject)
- bool exists ()
- string get ()
- int getLastModified ()
- string getPath ()
- bool read ()
Direct descendents
| Class | Description |
|---|---|
| Dir | Manipulate a directory |
| Executeable | handle php files |
| FileReadonly | checked reading of file sources |
Methods
constructor
FileSystemResource
FileSystemResource
(
string $filename
)
List of parameters:
| Name | Type | Description |
|---|---|---|
| $filename | string |
Description:
Create a new instance of this class.
compare with another object
bool
equals
(
object $anotherObject
)
List of parameters:
| Name | Type | Description |
|---|---|---|
| $anotherObject | object |
Description:
Returns bool(true) if this object and $anotherObject are equal and bool(false) otherwise.
Two instances are considered equal if and only if they are both objects of the same class and they both refer to the same filesystem resource.
Redefinition of: Object::equals()
return true, if the input stream resource exists
bool
exists
()
Description:
Redefined in descendants as:
- Dir::exists() : check if directory exists and is readable
- SML::exists() : test if a certain value exists
return stream contents
string
get
()
Description:
Redefined in descendants as:
- Dir::get() : return list of files within the directory
- FileReadonly::get() : get file contents
- DatFile::get() : retrieve a line of data from the file
- SML::get() : get a value from the file
- VDrive::get() : get a mountpoint
get time when file was last modified
int
getLastModified
()
Description:
Returns the file MTIME value (from cached value). The result is an UNIX timestamp (UTC), or bool(false) if an error occurs.
get path to the resource
string
getPath
()
Description:
Returns a string with the path and name of the currently open resource (directory or file).
«abstract» read contents of resource
bool
read
()
Description:
Since this is an abstract method, it is to implemented in the sub-classes.
Redefined in descendants as:
- Dir::read() : read contents and put results in cache (filter settings will be applied)
- Executeable::read() : require / include a php file
- FileReadonly::read() : read file contents
- DbBlob::read() : read file contents
- SML::read() : initialize file contents
- DbStructure::read() : read and initialize the file
- VDrive::read() : read the virtual drive
inherited from base classes
Inherited From Object
Documentation generated on Sat, 03 Jan 2009 22:22:25 +0100 by phpDocumentor 1.4.0
www.yanaframework.net