YANA 4 PHP Framework
Docs For Class VDrive
virtual Drive
Class to abstract from real filesystems by mapping filenames to aliases (mountpoints). Mountpoints my be mounted and unmounted at runtime. When reading a mountpoint, a corresponding file wrapper will be returned to work on the file.
Using virtual drives will clean your source from hard-coded file- and directory names, as well as doing all the job of creating and initializing the file wrappers for you.
Located in /includes/class_vdrive.php
Object | --InputStream | --SecureInputStream | --VDrive
Class | Description |
---|---|
Registry | Registry |
Name | Type | Description |
---|---|---|
$path | string | |
$options | array | |
$baseDir | string | |
$mode | int |
creates a new virtual drive instance
Name | Type | Description |
---|---|---|
$filename | string | |
$mode | int | |
$baseDir |
Loads the drive identified by $filename within the directory $baseDir and adds a new mountpoint containing the drive's data to the repository.
Name | Type | Description |
---|---|---|
$key | string | name of the drive to mount |
Returns the mountpoint specified by $key or bool(false) if no such mountpoint exists, or the mountpoint was unable to return any contents.
Redefinition of: SecureInputStream::get()
Name | Type | Description |
---|---|---|
$key | string | name of the drive to mount |
Mount the mountpoint identified by $key and copies the contents (if any) to the repository.
This function returns bool(true) on success, or bool(false) on error.
This (re-)loads the virtual drive and (re-)initializes it's contents.
If the file does not exist or is not readable, the functions returns bool(false), else bool(true) is returned.
Redefinition of: SecureInputStream::read()
This returns a human readable overview of the currently loaded virtual drive and it's contents.
You might want to use this for debugging purposes.
Redefinition of: SecureInputStream::toString()
Inherited From SecureInputStream
Inherited From InputStream
Inherited From Object
Documentation generated on Sun, 11 Mar 2007 15:02:50 +0100 by phpDocumentor 1.3.1