Class VFS_kolab

Description

VFS implementation for a Kolab IMAP server.

$Horde: framework/VFS/lib/VFS/kolab.php,v 1.1.2.3 2009/01/06 15:23:47 jan Exp $

Copyright 2002-2009 The Horde Project (http://www.horde.org/)

See the enclosed file COPYING for license information (LGPL). If you did not receive this file, see http://www.fsf.org/copyleft/lgpl.html.

Located in /VFS/lib/VFS/kolab.php (line 19)

VFS
   |
   --VFS_kolab
Variable Summary
Method Summary
 mixed createFolder (string $path, string $name)
 mixed deleteFile (string $path, string $name)
 mixed deleteFolder (string $path, string $name, [boolean $recursive = false])
 mixed emptyFolder (string $path)
 mixed listFolders ([string $path = ''], [mixed $filter = null], [boolean $dotfolders = true])
 string read (string $path, string $name)
 mixed write (string $path, string $name, string $tmpFile, [boolean $autocreate = false])
 void &_getAppHandler ( $app,  $uid)
 void _getAppUid ( $path)
 void _getAppUids ( $app)
 void _getFile ( $imap,  $uid,  $filename)
 void _getFolder ( $path,  $name)
 void _getFolders ()
 array _listFolder ([string $path = ''], [mixed $filter = null], [boolean $dotfiles = true], [boolean $dironly = false])
 void _parseMessage ( $imap,  $uid)
Variables
array $_folders (line 33)

Cache for the list of folders.

Horde_Kolab_IMAP $_imap = false (line 26)

Variable holding the connection to the Kolab storage system.

Inherited Variables

Inherited from VFS

VFS::$_credentials
VFS::$_logger
VFS::$_logLevel
VFS::$_params
VFS::$_permissions
VFS::$_vfsSize
Methods
createFolder (line 156)

Creates a folder on the VFS.

  • return: True on success or a PEAR_Error object on failure.
mixed createFolder (string $path, string $name)
  • string $path: The parent folder.
  • string $name: The name of the new folder.

Redefinition of:
VFS::createFolder()
Creates a folder in the VFS.
deleteFile (line 126)

Deletes a file from the VFS.

  • return: True on success or a PEAR_Error object on failure.
  • abstract:
mixed deleteFile (string $path, string $name)
  • string $path: The path to delete the file from.
  • string $name: The filename to delete.

Redefinition of:
VFS::deleteFile()
Deletes a file from the VFS.
deleteFolder (line 181)

Deletes a folder from the VFS.

  • return: True on success or a PEAR_Error object on failure.
mixed deleteFolder (string $path, string $name, [boolean $recursive = false])
  • string $path: The parent folder.
  • string $name: The name of the folder to delete.
  • boolean $recursive: Force a recursive delete?

Redefinition of:
VFS::deleteFolder()
Deletes a folder from the VFS.
emptyFolder (line 234)

Recursively remove all files and subfolders from the given folder.

  • return: True on success or a PEAR_Error object on failure.
mixed emptyFolder (string $path)
  • string $path: The path of the folder to empty.

Redefinition of:
VFS::emptyFolder()
Recursively remove all files and subfolders from the given folder.
listFolders (line 480)

Returns a sorted list of folders in the specified directory.

  • return: Folder list on success or a PEAR_Error object on failure.
mixed listFolders ([string $path = ''], [mixed $filter = null], [boolean $dotfolders = true])
  • string $path: The path of the directory to get the directory list for.
  • mixed $filter: Hash of items to filter based on folderlist.
  • boolean $dotfolders: Include dotfolders?

Redefinition of:
VFS::listFolders()
Returns a sorted list of folders in the specified directory.
read (line 43)

Retrieves a file from the VFS.

  • return: The file data.
string read (string $path, string $name)
  • string $path: The pathname to the file.
  • string $name: The filename to retrieve.

Redefinition of:
VFS::read()
Retrieves a file from the VFS.
write (line 86)

Stores a file in the VFS.

  • return: True on success or a PEAR_Error object on failure.
mixed write (string $path, string $name, string $tmpFile, [boolean $autocreate = false])
  • string $path: The path to store the file in.
  • string $name: The filename to use.
  • string $tmpFile: The temporary file containing the data to be stored.
  • boolean $autocreate: Automatically create directories?

Redefinition of:
VFS::write()
Stores a file in the VFS.
_getAppHandler (line 577)
void &_getAppHandler ( $app,  $uid)
  • $app
  • $uid
_getAppUid (line 568)
void _getAppUid ( $path)
  • $path
_getAppUids (line 605)
void _getAppUids ( $app)
  • $app
_getFile (line 433)
void _getFile ( $imap,  $uid,  $filename)
  • $imap
  • $uid
  • $filename
_getFolder (line 516)
void _getFolder ( $path,  $name)
  • $path
  • $name
_getFolders (line 532)
void _getFolders ()
_listFolder (line 272)

Returns an an unsorted file list of the specified directory.

  • return: File list on success or PEAR_Error on failure.
array _listFolder ([string $path = ''], [mixed $filter = null], [boolean $dotfiles = true], [boolean $dironly = false])
  • string $path: The path of the directory.
  • mixed $filter: String/hash to filter file/dirname on.
  • boolean $dotfiles: Show dotfiles?
  • boolean $dironly: Show only directories?

Redefinition of:
VFS::_listFolder()
Returns an an unsorted file list of the specified directory.
_parseMessage (line 382)
void _parseMessage ( $imap,  $uid)
  • $imap
  • $uid

Inherited Methods

Inherited From VFS

 VFS::VFS()
 VFS::autocreatePath()
 VFS::changePermissions()
 VFS::checkCredentials()
 VFS::copy()
 VFS::createFolder()
 VFS::delete()
 VFS::deleteFile()
 VFS::deleteFolder()
 VFS::emptyFolder()
 VFS::exists()
 VFS::factory()
 VFS::getCurrentDirectory()
 VFS::getFolderSize()
 VFS::getModifiablePermissions()
 VFS::getParam()
 VFS::getQuota()
 VFS::getRequiredCredentials()
 VFS::getVFSSize()
 VFS::isFolder()
 VFS::listFolder()
 VFS::listFolders()
 VFS::log()
 VFS::move()
 VFS::read()
 VFS::readByteRange()
 VFS::readFile()
 VFS::rename()
 VFS::setLogger()
 VFS::setParams()
 VFS::setQuota()
 VFS::setQuotaRoot()
 VFS::singleton()
 VFS::size()
 VFS::strlen()
 VFS::strtolower()
 VFS::write()
 VFS::writeData()
 VFS::_copyRecursive()
 VFS::_getPath()
 VFS::_getTempDir()
 VFS::_getTempFile()
 VFS::_listFolder()

Documentation generated on Sun, 30 Jan 2011 05:18:43 +0000 by phpDocumentor 1.4.3