VFS
[ class tree: VFS ] [ index: VFS ] [ all elements ]

Class: VFS_horde

Source Location: /VFS-0.3.0/lib/VFS/horde.php

Class Overview

VFS
   |
   --VFS_horde

VFS implementation for the Horde Application Framework.


Author(s):

Methods


Inherited Variables

Inherited Methods

Class: VFS

VFS::VFS()
Constructor.
VFS::autocreatePath()
Automatically creates any necessary parent directories in the specified $path.
VFS::changePermissions()
Changes permissions for an item on the VFS.
VFS::checkCredentials()
Checks the credentials that we have by calling _connect(), to see if there is a valid login.
VFS::copy()
Copies a file through the backend.
VFS::createFolder()
Creates a folder in the VFS.
VFS::delete()
Alias to deleteFile()
VFS::deleteFile()
Deletes a file from the VFS.
VFS::deleteFolder()
Deletes a folder from the VFS.
VFS::emptyFolder()
Recursively remove all files and subfolders from the given folder.
VFS::exists()
Returns if a given file or folder exists in a folder.
VFS::factory()
Attempts to return a concrete VFS instance based on $driver.
VFS::getCurrentDirectory()
Returns the current working directory of the VFS backend.
VFS::getFolderSize()
Returns the size of a folder
VFS::getModifiablePermissions()
Returns an array specifying what permissions are changeable for this VFS implementation.
VFS::getParam()
Returns configuration parameters.
VFS::getQuota()
Get quota information (used/allocated), in bytes.
VFS::getRequiredCredentials()
Returns the list of additional credentials required, if any.
VFS::getVFSSize()
Returns the size of the VFS item.
VFS::isFolder()
Checks if a given item is a folder.
VFS::listFolder()
Returns a file list of the directory passed in.
VFS::listFolders()
Returns a sorted list of folders in the specified directory.
VFS::log()
Logs a message if a PEAR Log object is available, and the message's priority is lower than or equal to the configured log level.
VFS::move()
Moves a file through the backend.
VFS::read()
Retrieves a file from the VFS.
VFS::readByteRange()
Retrieves a part of a file from the VFS. Particularly useful when reading large files which would exceed the PHP memory limits if they were stored in a string.
VFS::readFile()
Retrieves a file from the VFS as an on-disk local file.
VFS::rename()
Renames a file in the VFS.
VFS::setLogger()
Sets the PEAR Log object used to log informational or error messages.
VFS::setParams()
Sets configuration parameters.
VFS::setQuota()
Sets the VFS quota limit.
VFS::setQuotaRoot()
Sets the VFS quota root.
VFS::singleton()
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.
VFS::size()
Retrieves the size of a file from the VFS.
VFS::strlen()
Returns the character (not byte) length of a string.
VFS::strtolower()
Converts a string to all lowercase characters ignoring the current locale.
VFS::write()
Stores a file in the VFS.
VFS::writeData()
Stores a file in the VFS from raw data.
VFS::_copyRecursive()
Recursively copies a directory through the backend.
VFS::_getPath()
Returns the full path of an item.
VFS::_getTempDir()
Determines the location of the system temporary directory.
VFS::_getTempFile()
Creates a temporary file.

Class Details

[line 23]
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.



[ Top ]


Method Detail

VFS_horde (Constructor)   [line 37]

VFS_horde VFS_horde( [array $params = array()])

Constructor.

Parameters:

array   $params   —  A hash containing connection parameters.

[ Top ]

copy   [line 184]

mixed copy( string $path, string $name, string $dest)

Copies a file through the backend.
  • Return: True on success or a PEAR_Error object on failure.
  • Abstract:

Overrides VFS::copy() (Copies a file through the backend.)

Parameters:

string   $path   —  The path of the original file.
string   $name   —  The name of the original file.
string   $dest   —  The name of the destination directory.

[ Top ]

deleteFile   [line 202]

mixed deleteFile( string $path, string $name)

Deletes a file from the VFS.
  • Return: True on success or a PEAR_Error object on failure.
  • Abstract:

Overrides VFS::deleteFile() (Deletes a file from the VFS.)

Parameters:

string   $path   —  The path to delete the file from.
string   $name   —  The filename to delete.

[ Top ]

listFolders   [line 325]

mixed listFolders( [string $path = ''], [mixed $filter = null], [boolean $dotfolders = true])

Returns a sorted list of folders in the specified directory.
  • Return: Folder list on success or a PEAR_Error object on failure.
  • Abstract:

Overrides VFS::listFolders() (Returns a sorted list of folders in the specified directory.)

Parameters:

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?

[ Top ]

move   [line 165]

mixed move( string $path, string $name, string $dest)

Moves a file through the backend.
  • Return: True on success or a PEAR_Error object on failure.
  • Abstract:

Overrides VFS::move() (Moves a file through the backend.)

Parameters:

string   $path   —  The path of the original file.
string   $name   —  The name of the original file.
string   $dest   —  The destination file name.

[ Top ]

read   [line 95]

string read( string $path, string $name)

Retrieves a file from the VFS.
  • Return: The file data.
  • Abstract:

Overrides VFS::read() (Retrieves a file from the VFS.)

Parameters:

string   $path   —  The pathname to the file.
string   $name   —  The filename to retrieve.

[ Top ]

rename   [line 222]

mixed rename( string $oldpath, string $oldname, string $newpath, string $newname)

Renames a file in the VFS.
  • Return: True on success or a PEAR_Error object on failure.
  • Abstract:

Overrides VFS::rename() (Renames a file in the VFS.)

Parameters:

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.

[ Top ]

size   [line 77]

integer size( string $path, string $name)

Retrieves the size of a file from the VFS.
  • Return: The file size.
  • Abstract:

Overrides VFS::size() (Retrieves the size of a file from the VFS.)

Parameters:

string   $path   —  The pathname to the file.
string   $name   —  The filename to retrieve.

[ Top ]

write   [line 126]

mixed write( string $path, string $name, string $tmpFile, [boolean $autocreate = false])

Stores a file in the VFS.
  • Return: True on success or a PEAR_Error object on failure.
  • Abstract:

Overrides VFS::write() (Stores a file in the VFS.)

Parameters:

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?

[ Top ]

writeData   [line 146]

mixed writeData( string $path, string $name, string $data, [boolean $autocreate = false])

Stores a file in the VFS from raw data.
  • Return: True on success or a PEAR_Error object on failure.
  • Abstract:

Overrides VFS::writeData() (Stores a file in the VFS from raw data.)

Parameters:

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?

[ Top ]


Documentation generated on Mon, 11 Mar 2019 15:34:54 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.