Class VFS_horde

Description

VFS implementation for the Horde Application Framework.

Required parameters:

   'horde_base'  Filesystem location of a local Horde installation.

Optional parameters:

   'user'      A valid Horde user name.
   'password'  The user's password.

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

Copyright 2006-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/horde.php (line 23)

VFS
   |
   --VFS_horde
Variable Summary
Method Summary
 VFS_horde VFS_horde ([array $params = array()])
 mixed copy (string $path, string $name, string $dest)
 mixed deleteFile (string $path, string $name)
 mixed listFolders ([string $path = ''], [mixed $filter = null], [boolean $dotfolders = true])
 mixed move (string $path, string $name, string $dest)
 string read (string $path, string $name)
 mixed rename (string $oldpath, string $oldname, string $newpath, string $newname)
 integer size (string $path, string $name)
 mixed write (string $path, string $name, string $tmpFile, [boolean $autocreate = false])
 mixed writeData (string $path, string $name, string $data, [boolean $autocreate = false])
 void _connect ()
 array _listFolder (string $path, [mixed $filter = null], [boolean $dotfiles = true], [boolean $dironly = false])
Variables
Registry $_registry (line 30)

Reference to a Horde Registry instance.

Inherited Variables

Inherited from VFS

VFS::$_credentials
VFS::$_logger
VFS::$_logLevel
VFS::$_params
VFS::$_permissions
VFS::$_vfsSize
Methods
Constructor VFS_horde (line 37)

Constructor.

VFS_horde VFS_horde ([array $params = array()])
  • array $params: A hash containing connection parameters.
copy (line 184)

Copies a file through the backend.

  • return: True on success or a PEAR_Error object on failure.
  • abstract:
mixed copy (string $path, string $name, string $dest)
  • string $path: The path of the original file.
  • string $name: The name of the original file.
  • string $dest: The name of the destination directory.

Redefinition of:
VFS::copy()
Copies a file through the backend.
deleteFile (line 202)

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.
listFolders (line 325)

Returns a sorted list of folders in the specified directory.

  • return: Folder list on success or a PEAR_Error object on failure.
  • abstract:
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.
move (line 165)

Moves a file through the backend.

  • return: True on success or a PEAR_Error object on failure.
  • abstract:
mixed move (string $path, string $name, string $dest)
  • string $path: The path of the original file.
  • string $name: The name of the original file.
  • string $dest: The destination file name.

Redefinition of:
VFS::move()
Moves a file through the backend.
read (line 95)

Retrieves a file from the VFS.

  • return: The file data.
  • abstract:
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.
rename (line 222)

Renames a file in the VFS.

  • return: True on success or a PEAR_Error object on failure.
  • abstract:
mixed rename (string $oldpath, string $oldname, string $newpath, string $newname)
  • string $oldpath: The old path to the file.
  • string $oldname: The old filename.
  • string $newpath: The new path of the file.
  • string $newname: The new filename.

Redefinition of:
VFS::rename()
Renames a file in the VFS.
size (line 77)

Retrieves the size of a file from the VFS.

  • return: The file size.
  • abstract:
integer size (string $path, string $name)
  • string $path: The pathname to the file.
  • string $name: The filename to retrieve.

Redefinition of:
VFS::size()
Retrieves the size of a file from the VFS.
write (line 126)

Stores a file in the VFS.

  • return: True on success or a PEAR_Error object on failure.
  • abstract:
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.
writeData (line 146)

Stores a file in the VFS from raw data.

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

Redefinition of:
VFS::writeData()
Stores a file in the VFS from raw data.
_connect (line 55)
void _connect ()
_listFolder (line 242)

Returns an an unsorted file list of the specified directory.

  • return: File list on success or PEAR_Error on failure.
  • abstract:
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.

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:04 +0000 by phpDocumentor 1.4.3