spunQ_IFileNode Interface Reference
Interface for accessing an object in the file system. More...
Public Member Functions | |
| exists () | |
| Whether this node already exists in the file system. | |
| residesIn (spunQ_IFolder $folder) | |
| Checks whether this file is in given folder or one of its subfolders. | |
| isReadable () | |
| Whether the node is readable. | |
| getPath () | |
| Returns the path pointing to the node. | |
| getPrettyPath () | |
| Returns the most unique and human-readable path. | |
| getContainingFolder () | |
| Returns the folder this node is residing in. | |
| getName () | |
| Returns the name of this node, deprived of its path. | |
| getLastAccessTime () | |
| Returns the time of last access of this node. | |
| getLastModificationTime () | |
| Returns the time of last modification of this node. | |
Detailed Description
Interface for accessing an object in the file system.Possible implementations include files, folders, named pipes, device nodes, etc.
Definition at line 8 of file IFileNode.interface.php.
Member Function Documentation
| spunQ_IFileNode::exists | ( | ) |
Whether this node already exists in the file system.
It is perfectly valid for an object to describe a non-existent node.
- Returns:
- bool
Implemented in spunQ_FileNode.
| spunQ_IFileNode::getContainingFolder | ( | ) |
| spunQ_IFileNode::getLastAccessTime | ( | ) |
Returns the time of last access of this node.
- Returns:
- int The result is a unix-timestamp
- Exceptions:
-
spunQ_IOException If the timestamp could not be read.
Implemented in spunQ_FileNode.
| spunQ_IFileNode::getLastModificationTime | ( | ) |
Returns the time of last modification of this node.
- Returns:
- int The result is a unix-timestamp
- Exceptions:
-
spunQ_IOException If the timestamp could not be read.
Implemented in spunQ_FileNode.
| spunQ_IFileNode::getName | ( | ) |
| spunQ_IFileNode::getPath | ( | ) |
| spunQ_IFileNode::getPrettyPath | ( | ) |
Returns the most unique and human-readable path.
If the file exists, the builtin function realpath() is used. Otherwise, a better-looking path is achieved through string manipulation, i.e. '../a/../d/./' becomes '../d/'.
- Returns:
- string
Implemented in spunQ_FileNode.
| spunQ_IFileNode::isReadable | ( | ) |
| spunQ_IFileNode::residesIn | ( | spunQ_IFolder $ | folder | ) |
Checks whether this file is in given folder or one of its subfolders.
- Parameters:
-
$folder The folder to test against.
- Returns:
- bool
Implemented in spunQ_FileNode.
The documentation for this interface was generated from the following file:
