Class Horde_Vfs_Kolab
VFS implementation for a Kolab IMAP server.
Copyright 2002-2012 Horde LLC (http://www.horde.org/)
See the enclosed file COPYING for license information (LGPL). If you
did not receive this file, see http://www.horde.org/licenses/lgpl21.
-
Horde_Vfs_Base
-
Horde_Vfs_Kolab
Methods summary
public
string
|
#
read( string $path, string $name )
Retrieves a file from the VFS.
Retrieves a file from the VFS.
Parameters
- $path
- The pathname to the file.
- $name
- The filename to retrieve.
Returns
string
The file data.
Throws
Overrides
|
public
|
#
write( string $path, string $name, string $tmpFile, boolean $autocreate = false )
Stores a file in the VFS.
Stores a file in the VFS.
Parameters
- $path
- The path to store the file in.
- $name
- The filename to use.
- $tmpFile
- <p>The temporary file containing the data to
be stored.</p>
- $autocreate
- Automatically create directories?
Throws
Overrides
|
public
|
#
deleteFile( string $path, string $name )
Deletes a file from the VFS.
Deletes a file from the VFS.
Parameters
- $path
- The path to delete the file from.
- $name
- The filename to delete.
Throws
Overrides
|
public
|
#
createFolder( string $path, string $name )
Creates a folder on the VFS.
Creates a folder on the VFS.
Parameters
- $path
- The parent folder.
- $name
- The name of the new folder.
Throws
Overrides
|
public
|
#
deleteFolder( string $path, string $name, boolean $recursive = false )
Deletes a folder from the VFS.
Deletes a folder from the VFS.
Parameters
- $path
- The parent folder.
- $name
- The name of the folder to delete.
- $recursive
- Force a recursive delete?
Throws
Overrides
|
public
|
#
emptyFolder( string $path )
Recursively remove all files and subfolders from the given
folder.
Recursively remove all files and subfolders from the given
folder.
Parameters
- $path
- The path of the folder to empty.
Throws
Overrides
|
public
array
|
#
listFolders( string $path = '', mixed $filter = null, boolean $dotfolders = true )
Returns a sorted list of folders in the specified directory.
Returns a sorted list of folders in the specified directory.
Parameters
- $path
- <p>The path of the directory to get the
directory list for.</p>
- $filter
- Hash of items to filter based on folderlist.
- $dotfolders
- Include dotfolders?
Returns
array
Folder list.
Throws
Overrides
|
Methods inherited from Horde_Vfs_Base
__construct(),
autocreatePath(),
changePermissions(),
checkCredentials(),
copy(),
delete(),
exists(),
getCurrentDirectory(),
getFolderSize(),
getModifiablePermissions(),
getParam(),
getQuota(),
getRequiredCredentials(),
getVFSSize(),
isFolder(),
listFolder(),
move(),
readByteRange(),
readFile(),
rename(),
setParams(),
setQuota(),
setQuotaRoot(),
size(),
writeData()
|