Index
A
- Directory::addDirectory() — Method in class Directory
- Adds child Directory.
- Directory::addFile() — Method in class Directory
- Adds child File.
- Directory::addLink() — Method in class Directory
- Adds child Link.
- Directory::addNode() — Method in class Directory
- Adds child Node.
- Node::atime() — Method in class Node
- Returns last access time
- FileHandler::atEof() — Method in class FileHandler
- Tells whether pointer is at the end of file.
B
- Node::basename() — Method in class Node
- Returns Node basename.
C
- Container — Class in namespace VirtualFileSystem
- Class to hold the filesystem structure as object representation. It also provides access and factory methods for file system management.
- Container::createDir() — Method in class Container
- Creates Directory at given path.
- Container::createLink() — Method in class Container
- Creates link at given path
- Container::createFile() — Method in class Container
- Creates file at given path
- Container::createStructure() — Method in class Container
- Creates struture
- FileSystem::container() — Method in class FileSystem
- Returns Container instance.
- FileSystem::createDirectory() — Method in class FileSystem
- Creates and returns a directory
- FileSystem::createFile() — Method in class FileSystem
- Creates and returns a file
- FileSystem::createStructure() — Method in class FileSystem
- Creates fs structure
- FileSystem::createLink() — Method in class FileSystem
- Creates and returns a link
- Directory::childAt() — Method in class Directory
- Returns child Node existing at path.
- Directory::children() — Method in class Directory
- Returns children
- Node::chmod() — Method in class Node
- Changes access to file.
- Node::chown() — Method in class Node
- Changes ownership.
- Node::chgrp() — Method in class Node
- Changes group ownership.
- Node::ctime() — Method in class Node
- Returns last inode change time (chown etc.)
- $Wrapper — Property in class Wrapper
D
- Container::directoryAt() — Method in class Container
- Returns directory at given path
- Directory — Class in namespace VirtualFileSystem\Structure
- FileSystem Directory representation.
- File::data() — Method in class File
- Returns contents.
- Node::dirname() — Method in class Node
- Returns Node parent absolute path.
- Wrapper::dir_opendir() — Method in class Wrapper
- Opens directory for iteration
- Wrapper::dir_closedir() — Method in class Wrapper
- Closes opened dir
- Wrapper::dir_readdir() — Method in class Wrapper
- Returns next file url in directory
- Wrapper::dir_rewinddir() — Method in class Wrapper
- Resets directory iterator
- DirectoryHandler — Class in namespace VirtualFileSystem\Wrapper
- User as directory handle by streamWrapper implementation.
F
- Container::factory() — Method in class Container
- Returns Factory instance
- Container::fileAt() — Method in class Container
- Returns file at given path
- FileExistsException — Class in namespace VirtualFileSystem\Exception
- Thrown when trying to override Node at address (duplicate prevention).
- Factory — Class in namespace VirtualFileSystem
- Factory class to encapsulate object creation.
- FileSystem — Class in namespace VirtualFileSystem
- Main 'access' class to vfs implementation. It will register new stream wrapper on instantiation.
- File — Class in namespace VirtualFileSystem\Structure
- Object representation of File.
- FileHandler — Class in namespace VirtualFileSystem\Wrapper
- User as file handle by streamWrapper implementation.
G
- Container::getPermissionHelper() — Method in class Container
- Returns PermissionHelper with given node in context
- Factory::getRoot() — Method in class Factory
- Creates Root object.
- Factory::getDir() — Method in class Factory
- Creates Directory object.
- Factory::getFile() — Method in class Factory
- Creates File object.
- Factory::getLink() — Method in class Factory
- Creates Link object.
- Loader::getNamespaceSeparator() — Method in class Loader
- Gets the namespace seperator used by classes in the namespace of this class loader.
- Loader::getIncludePath() — Method in class Loader
- Gets the base include path for all class files in the namespace of this class loader.
- Loader::getFileExtension() — Method in class Loader
- Gets the file extension of class files in the namespace of this class loader.
- Link::getDestination() — Method in class Link
- Node::group() — Method in class Node
- Returns group ownership.
- Wrapper::getContainerFromContext() — Method in class Wrapper
- Returns Container object fished form defaultcontextoptions by scheme.
- PermissionHelper::groupIsOwner() — Method in class PermissionHelper
- Checks whether group_id on file is the same as executing user
- PermissionHelper::groupCanRead() — Method in class PermissionHelper
- Checks whether file is readable for group
- PermissionHelper::groupCanWrite() — Method in class PermissionHelper
- Checks whether file is writable for group
H
- Container::hasNodeAt() — Method in class Container
- Checks whether filesystem has Node at given path
I
- DirectoryHandler::iterator() — Method in class DirectoryHandler
- Returns children iterator
- FileHandler::isOpenedForWriting() — Method in class FileHandler
- Checks if pointer allows writing
- FileHandler::isOpenedForReading() — Method in class FileHandler
- Checks if pointer allows reading
- PermissionHelper::isReadable() — Method in class PermissionHelper
- Checks whether file is readable (by user, group or world)
- PermissionHelper::isWritable() — Method in class PermissionHelper
- Checks whether file is writable (by user, group or world)
L
- Loader — Class in namespace VirtualFileSystem
- Class Loader to use with PEAR installation
- Loader::loadClass() — Method in class Loader
- Loads the given class or interface.
- File::lock() — Method in class File
- Link — Class in namespace VirtualFileSystem\Structure
- Object representation of a Link.
- FileHandler::lock() — Method in class FileHandler
M
- Container::move() — Method in class Container
- Moves Node from source to destination
- Node::mode() — Method in class Node
- Returns file mode
- Node::mtime() — Method in class Node
- Returns last modification time
- Wrapper::mkdir() — Method in class Wrapper
- Called in response to mkdir to create directory.
N
- Container::nodeAt() — Method in class Container
- Returns filesystem Node|Directory|File|Root at given path.
- NotDirectoryException — Class in namespace VirtualFileSystem\Exception
- Thrown when non-existing Node is requested.
- NotFileException — Class in namespace VirtualFileSystem\Exception
- Thrown when non-existing Node is requested.
- NotFoundException — Class in namespace VirtualFileSystem\Exception
- Thrown when non-existing Node is requested.
- Node — Class in namespace VirtualFileSystem\Structure
- Abstract class to represent filesystem Node.
O
- FileHandler::offsetPosition() — Method in class FileHandler
- Offsets position by $offset
P
- FileSystem::path() — Method in class FileSystem
- Returns absolute path to full URI path (with scheme)
- Node::path() — Method in class Node
- Returns node path.
- Root::path() — Method in class Root
- Returns node path.
- FileHandler::position() — Method in class FileHandler
- Returns current pointer position.
- PermissionHelper — Class in namespace VirtualFileSystem\Wrapper
- Class to encapsulate permission checks
R
- Container::root() — Method in class Container
- Returns Root instance
- Container::remove() — Method in class Container
- Removes node at $path
- FileSystem::root() — Method in class FileSystem
- Returns Root instance.
- Loader::register() — Method in class Loader
- Installs this class loader on the SPL autoload stack.
- Directory::remove() — Method in class Directory
- Removes child Node
- Root — Class in namespace VirtualFileSystem\Structure
- FileSystem Root representation.
- Wrapper::rename() — Method in class Wrapper
- Renames/Moves file
- Wrapper::rmdir() — Method in class Wrapper
- Removes directory
- FileHandler::read() — Method in class FileHandler
- Will read and return $bytes bytes from file. Will advance pointer by $bytes bytes.
S
- Container::setFactory() — Method in class Container
- Sets Factory instance
- Container::setPermissionHelper() — Method in class Container
- Sets permission helper instance
- FileSystem::scheme() — Method in class FileSystem
- Returns wrapper scheme.
- Loader::setNamespaceSeparator() — Method in class Loader
- Sets the namespace separator used by classes in the namespace of this class loader.
- Loader::setIncludePath() — Method in class Loader
- Sets the base include path for all class files in the namespace of this class loader.
- Loader::setFileExtension() — Method in class Loader
- Sets the file extension of class files in the namespace of this class loader.
- Directory::size() — Method in class Directory
- Returns size as the number of child elements.
- File::size() — Method in class File
- Returns Node size.
- File::setData() — Method in class File
- Sets contents.
- Link::size() — Method in class Link
- Returns Node size.
- Node::size() — Method in class Node
- Returns Node size.
- Node::setBasename() — Method in class Node
- Sets new basename
- Node::setAccessTime() — Method in class Node
- Sets last access time
- Node::setModificationTime() — Method in class Node
- Sets last modification time
- Node::setChangeTime() — Method in class Node
- Sets last inode change time
- Root::setScheme() — Method in class Root
- Set root scheme for use in path method.
- Wrapper::stripScheme() — Method in class Wrapper
- Returns path stripped of url scheme (http://, ftp://, test:// etc.)
- Wrapper::stream_tell() — Method in class Wrapper
- Wrapper::stream_close() — Method in class Wrapper
- Wrapper::stream_open() — Method in class Wrapper
- Opens stream in selected mode.
- Wrapper::stream_write() — Method in class Wrapper
- Writes data to stream.
- Wrapper::stream_stat() — Method in class Wrapper
- Returns stat data for file inclusion. Currently disabled.
- Wrapper::stream_read() — Method in class Wrapper
- Reads and returns $bytes amount of bytes from stream.
- Wrapper::stream_eof() — Method in class Wrapper
- Checks whether pointer has reached EOF.
- Wrapper::stream_metadata() — Method in class Wrapper
- Called in response to chown/chgrp/touch/chmod etc.
- Wrapper::stream_seek() — Method in class Wrapper
- Sets file pointer to specified position
- Wrapper::stream_truncate() — Method in class Wrapper
- Truncates file to given size
- Wrapper::stream_lock() — Method in class Wrapper
- DirectoryHandler::setDirectory() — Method in class DirectoryHandler
- Sets directory in context.
- FileHandler::setFile() — Method in class FileHandler
- Sets file in context.
- FileHandler::seekToEnd() — Method in class FileHandler
- Moves pointer to the end of file (for append modes).
- FileHandler::setReadOnlyMode() — Method in class FileHandler
- Sets handler to read only
- FileHandler::setReadWriteMode() — Method in class FileHandler
- Sets handler into read/write mode
- FileHandler::setWriteOnlyMode() — Method in class FileHandler
- PermissionHelper::setNode() — Method in class PermissionHelper
T
- FileHandler::truncate() — Method in class FileHandler
- Removed all data from file and sets pointer to 0
U
- Factory::updateMetadata() — Method in class Factory
- Updates time and ownership of a node
- Factory::updateFileTimes() — Method in class Factory
- Update file a/c/m times
- Loader::unregister() — Method in class Loader
- Uninstalls this class loader from the SPL autoloader stack.
- Node::user() — Method in class Node
- Returns ownership.
- Node::url() — Method in class Node
- Returns node URL.
- Root::url() — Method in class Root
- Returns node URL.
- Wrapper::url_stat() — Method in class Wrapper
- Returns file stat information
- Wrapper::unlink() — Method in class Wrapper
- Deletes file at given path
- PermissionHelper::userIsOwner() — Method in class PermissionHelper
- Checks whether user_id on file is the same as executing user
- PermissionHelper::userCanRead() — Method in class PermissionHelper
- Checks whether file is readable for user
- PermissionHelper::userCanWrite() — Method in class PermissionHelper
- Checks whether file is writable for user
- PermissionHelper::userIsRoot() — Method in class PermissionHelper
- Checks whether userid is 0 - root.
W
- Wrapper — Class in namespace VirtualFileSystem
- Stream wrapper class. This is the class that PHP uses as the stream operations handler.
- FileHandler::write() — Method in class FileHandler
- Writes data to file. Will return the number of bytes written. Will advance pointer by number of bytes written.
- PermissionHelper::worldCanRead() — Method in class PermissionHelper
- Checks whether file is readable for world
- PermissionHelper::worldCanWrite() — Method in class PermissionHelper
- Checks whether file is writable for world
_
- Container::__construct() — Method in class Container
- Class constructor. Sets factory and root object on init.
- Factory::__construct() — Method in class Factory
- Class constructor. Sets user/group to current system user/group.
- FileSystem::__construct() — Method in class FileSystem
- Class constructor. Will register both, the stream default options and wrapper handler.
- FileSystem::__destruct() — Method in class FileSystem
- Remoces wrapper registered for scheme associated with FileSystem instance.
- Loader::__construct() — Method in class Loader
- Creates a new Loader that loads classes of the specified namespace.
- Directory::__construct() — Method in class Directory
- Class constructor.
- File::__construct() — Method in class File
- Class constructor.
- Link::__construct() — Method in class Link
- Class constructor.
- Node::__construct() — Method in class Node
- Class constructor.
- Node::__toString() — Method in class Node
- Returns node absolute path (without scheme).
- Root::__construct() — Method in class Root
- Class constructor.
- PermissionHelper::__construct() — Method in class PermissionHelper