| [ Index ] |
|
Code source de Horde 3.1.3 |
[Code source] [Imprimer] [Statistiques]
(pas de description)
| Poids: | 296 lignes (9 kb) |
| Inclus ou requis: | 0 fois |
| Référencé: | 0 fois |
| Nécessite: | 0 fichiers |
VFS_Object:: (17 méthodes):
VFS_Object()
factory()
singleton()
checkCredentials()
setParams()
read()
write()
writeData()
deleteFile()
rename()
createFolder()
deleteFolder()
listFolder()
changePermissions()
getRequiredCredentials()
getModifiablePermissions()
_disconnect()
Classe: VFS_Object - X-Ref
A wrapper for the VFS class to return objects, instead of arrays.| VFS_Object(&$vfs) X-Ref |
| Constructor. If you pass in an existing VFS object, it will be used as the VFS object for this object. param: VFS &$vfs The VFS object to wrap. |
| factory($driver, $params = array() X-Ref |
| Attempts to return a concrete VFS_Object instance based on $driver. param: mixed $driver The type of concrete VFS subclass to return. If param: array $params A hash containing any additional configuration or return: VFS_Object The newly created concrete VFS_Object instance, or |
| singleton($driver, $params = array() X-Ref |
| Attempts to return a reference to a concrete VFS instance based on $driver. It will only create a new instance if no VFS instance with the same parameters currently exists. This should be used if multiple types of file backends (and, thus, multiple VFS instances) are required. This method must be invoked as: $var = &VFS::singleton() param: mixed $driver The type of concrete VFS subclass to return. If param: array $params A hash containing any additional configuration or return: VFS_Object The concrete VFS_Object reference, or false on |
| checkCredentials() X-Ref |
| Check the credentials that we have to see if there is a valid login. return: mixed True on success, PEAR_Error describing the problem |
| setParams($params = array() X-Ref |
| Set configuration parameters. param: array $params An associative array of parameter name/value |
| read($path) X-Ref |
| Retrieve a file from the VFS. param: string $path The pathname to the file. return: string The file data. |
| write($path, $tmpFile, $autocreate = false) X-Ref |
| Store a file in the VFS. param: string $path The path to store the file in. param: string $tmpFile The temporary file containing the data to be param: boolean $autocreate Automatically create directories? return: mixed True on success or a PEAR_Error object on failure. |
| writeData($path, $data, $autocreate = false) X-Ref |
| Store a file in the VFS from raw data. param: string $path The path to store the file in. param: string $data The file data. param: boolean $autocreate Automatically create directories? return: mixed True on success or a PEAR_Error object on failure. |
| deleteFile($path) X-Ref |
| Delete a file from the VFS. param: string $path The path to store the file in. param: string $name The filename to use. return: mixed True on success or a PEAR_Error object on failure. |
| rename($oldpath, $newpath) X-Ref |
| Rename a file in the VFS. param: string $oldpath The old path to the file. param: string $oldname The old filename. param: string $newpath The new path of the file. param: string $newname The new filename. return: mixed True on success or a PEAR_Error object on failure. |
| createFolder($path) X-Ref |
| Create a folder in the VFS. param: string $path The path to the folder. return: mixed True on success or a PEAR_Error object on failure. |
| deleteFolder($path) X-Ref |
| Deletes a folder from the VFS. param: string $path The path of the folder to delete. return: mixed True on success or a PEAR_Error object on failure. |
| listFolder($path) X-Ref |
| Returns a VFS_ListItem object if the folder can be read, or a PEAR_Error if it can't be. Returns false once the folder has been completely read. param: string $path The path of the diretory. return: mixed File list (array) on success, a PEAR_Error |
| changePermissions($path, $permission) X-Ref |
| Changes permissions for an Item on the VFS. param: string $path Holds the path of directory of the Item. param: string $permission TODO return: mixed True on success or a PEAR_Error object on failure. |
| getRequiredCredentials() X-Ref |
| Return the list of additional credentials required, if any. return: array Credential list. |
| getModifiablePermissions() X-Ref |
| Return the array specificying what permissions are changeable for this implementation. return: array Changeable permisions. |
| _disconnect() X-Ref |
| Close any resources that need to be closed. |
| Généré le : Sun Feb 25 18:01:28 2007 | par Balluche grâce à PHPXref 0.7 |