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

Element index for package VFS

[ a ] [ b ] [ c ] [ d ] [ e ] [ f ] [ g ] [ h ] [ i ] [ k ] [ l ] [ m ] [ o ] [ r ] [ s ] [ u ] [ v ] [ w ] [ _ ]

_

_copyRecursive
in file VFS.php, method VFS::_copyRecursive()
    Recursively copies a directory through the backend.
_cp
in file vfs.php, function _cp()
    Copies one or several files to a different location.
_getPath
in file VFS.php, method VFS::_getPath()
    Returns the full path of an item.
_getTempDir
in file VFS.php, method VFS::_getTempDir()
    Determines the location of the system temporary directory.
_getTempFile
in file VFS.php, method VFS::_getTempFile()
    Creates a temporary file.
top

a

autocreatePath
in file VFS.php, method VFS::autocreatePath()
    Automatically creates any necessary parent directories in the specified $path.
top

b

Browser.php
procedural page Browser.php
top

c

changePermissions
in file VFS.php, method VFS::changePermissions()
    Changes permissions for an item on the VFS.
changePermissions
in file Object.php, method VFS_Object::changePermissions()
    Changes permissions for an Item on the VFS.
changePermissions
in file file.php, method VFS_file::changePermissions()
    Changes permissions for an item in the VFS.
changePermissions
in file ssh2.php, method VFS_ssh2::changePermissions()
    Changes permissions for an item on the VFS.
changePermissions
in file musql.php, method VFS_musql::changePermissions()
    Changes permissions for an Item on the VFS.
changePermissions
in file ftp.php, method VFS_ftp::changePermissions()
    Changes permissions for an item on the VFS.
checkCredentials
in file VFS.php, method VFS::checkCredentials()
    Checks the credentials that we have by calling _connect(), to see if there is a valid login.
checkCredentials
in file Object.php, method VFS_Object::checkCredentials()
    Check the credentials that we have to see if there is a valid login.
copy
in file smb.php, method VFS_smb::copy()
    Copies a file through the backend.
copy
in file sql_file.php, method VFS_sql_file::copy()
    Copies a file through the backend.
copy
in file ssh2.php, method VFS_ssh2::copy()
    Copies a file through the backend.
copy
in file ftp.php, method VFS_ftp::copy()
    Copies a file through the backend.
copy
in file file.php, method VFS_file::copy()
    Copies a file through the backend.
copy
in file horde.php, method VFS_horde::copy()
    Copies a file through the backend.
copy
in file VFS.php, method VFS::copy()
    Copies a file through the backend.
cp
in file vfs.php, function cp()
    Copies one or several files to a different location.
createFolder
in file ssh2.php, method VFS_ssh2::createFolder()
    Creates a folder on the VFS.
createFolder
in file VFS.php, method VFS::createFolder()
    Creates a folder in the VFS.
createFolder
in file Object.php, method VFS_Object::createFolder()
    Create a folder in the VFS.
createFolder
in file ftp.php, method VFS_ftp::createFolder()
    Creates a folder on the VFS.
createFolder
in file file.php, method VFS_file::createFolder()
    Creates a folder on the VFS.
createFolder
in file kolab.php, method VFS_kolab::createFolder()
    Creates a folder on the VFS.
createFolder
in file musql.php, method VFS_musql::createFolder()
    Creates a folder on the VFS.
createFolder
in file sql.php, method VFS_sql::createFolder()
    Creates a folder on the VFS.
createFolder
in file smb.php, method VFS_smb::createFolder()
    Creates a folder on the VFS.
createFolder
in file sql_file.php, method VFS_sql_file::createFolder()
    Creates a folder on the VFS.
top

d

delete
in file VFS.php, method VFS::delete()
    Alias to deleteFile()
deleteFile
in file Object.php, method VFS_Object::deleteFile()
    Delete a file from the VFS.
deleteFile
in file file.php, method VFS_file::deleteFile()
    Delete a file from the VFS.
deleteFile
in file smb.php, method VFS_smb::deleteFile()
    Deletes a file from the VFS.
deleteFile
in file sql.php, method VFS_sql::deleteFile()
    Delete a file from the VFS.
deleteFile
in file ssh2.php, method VFS_ssh2::deleteFile()
    Deletes a file from the VFS.
deleteFile
in file sql_file.php, method VFS_sql_file::deleteFile()
    Delete a file from the VFS.
deleteFile
in file musql.php, method VFS_musql::deleteFile()
    Deletes a file from the VFS.
deleteFile
in file ftp.php, method VFS_ftp::deleteFile()
    Deletes a file from the VFS.
deleteFile
in file horde.php, method VFS_horde::deleteFile()
    Deletes a file from the VFS.
deleteFile
in file VFS.php, method VFS::deleteFile()
    Deletes a file from the VFS.
deleteFile
in file kolab.php, method VFS_kolab::deleteFile()
    Deletes a file from the VFS.
deleteFolder
in file sql_file.php, method VFS_sql_file::deleteFolder()
    Delete a folder from the VFS.
deleteFolder
in file VFS.php, method VFS::deleteFolder()
    Deletes a folder from the VFS.
deleteFolder
in file ssh2.php, method VFS_ssh2::deleteFolder()
    Deletes a folder from the VFS.
deleteFolder
in file Object.php, method VFS_Object::deleteFolder()
    Deletes a folder from the VFS.
deleteFolder
in file ftp.php, method VFS_ftp::deleteFolder()
    Deletes a folder from the VFS.
deleteFolder
in file file.php, method VFS_file::deleteFolder()
    Delete a folder from the VFS.
deleteFolder
in file kolab.php, method VFS_kolab::deleteFolder()
    Deletes a folder from the VFS.
deleteFolder
in file musql.php, method VFS_musql::deleteFolder()
    Deletes a folder from the VFS.
deleteFolder
in file smb.php, method VFS_smb::deleteFolder()
    Deletes a folder from the VFS.
deleteFolder
in file sql.php, method VFS_sql::deleteFolder()
    Delete a folder from the VFS.
top

e

emptyFolder
in file VFS.php, method VFS::emptyFolder()
    Recursively remove all files and subfolders from the given folder.
emptyFolder
in file kolab.php, method VFS_kolab::emptyFolder()
    Recursively remove all files and subfolders from the given folder.
exists
in file VFS.php, method VFS::exists()
    Returns if a given file or folder exists in a folder.
exists
in file file.php, method VFS_file::exists()
    Returns if a given file or folder exists in a folder.
top

f

factory
in file VFS.php, method VFS::factory()
    Attempts to return a concrete VFS instance based on $driver.
factory
in file Object.php, method VFS_Object::factory()
    Attempts to return a concrete VFS_Object instance based on $driver.
file.php
procedural page file.php
ftp.php
procedural page ftp.php
top

g

gc
in file GC.php, method VFS_GC::gc()
    Garbage collect files in the VFS storage system.
gc
in file sql.php, method VFS_sql::gc()
    Garbage collect files in the VFS storage system.
getCurrentDirectory
in file VFS.php, method VFS::getCurrentDirectory()
    Returns the current working directory of the VFS backend.
getCurrentDirectory
in file ftp.php, method VFS_ftp::getCurrentDirectory()
    Returns the current working directory on the FTP server.
getCurrentDirectory
in file ssh2.php, method VFS_ssh2::getCurrentDirectory()
    Returns the current working directory on the SSH2 server.
getFolderSize
in file VFS.php, method VFS::getFolderSize()
    Returns the size of a folder
getFolderSize
in file sql.php, method VFS_sql::getFolderSize()
    Returns the size of a file.
getModifiablePermissions
in file Object.php, method VFS_Object::getModifiablePermissions()
    Return the array specificying what permissions are changeable for this implementation.
getModifiablePermissions
in file VFS.php, method VFS::getModifiablePermissions()
    Returns an array specifying what permissions are changeable for this VFS implementation.
getParam
in file VFS.php, method VFS::getParam()
    Returns configuration parameters.
getQuota
in file VFS.php, method VFS::getQuota()
    Get quota information (used/allocated), in bytes.
getRequiredCredentials
in file VFS.php, method VFS::getRequiredCredentials()
    Returns the list of additional credentials required, if any.
getRequiredCredentials
in file Object.php, method VFS_Object::getRequiredCredentials()
    Return the list of additional credentials required, if any.
getUI
in file Browser.php, method VFS_Browser::getUI()
    TODO
getVFSSize
in file VFS.php, method VFS::getVFSSize()
    Returns the size of the VFS item.
GC.php
procedural page GC.php
top

h

horde.php
procedural page horde.php
top

i

isFolder
in file ssh2.php, method VFS_ssh2::isFolder()
    Checks if a given item is a folder.
isFolder
in file VFS.php, method VFS::isFolder()
    Checks if a given item is a folder.
isFolder
in file sql.php, method VFS_sql::isFolder()
    VFS_sql override of isFolder() to check for root folder.
isFolder
in file ftp.php, method VFS_ftp::isFolder()
    Checks if a given item is a folder.
isFolder
in file smb.php, method VFS_smb::isFolder()
    Checks if a given pathname is a folder.
isFolder
in file file.php, method VFS_file::isFolder()
    Check if a given pathname is a folder.
top

k

kolab.php
procedural page kolab.php
top

l

listFolder
in file Object.php, method VFS_Object::listFolder()
    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.
listFolder
in file VFS.php, method VFS::listFolder()
    Returns a file list of the directory passed in.
listFolder
in file smb.php, method VFS_smb::listFolder()
    Returns an unsorted file list.
listFolders
in file sql_file.php, method VFS_sql_file::listFolders()
    Returns a sorted list of folders in specified directory.
listFolders
in file ssh2.php, method VFS_ssh2::listFolders()
    Returns a sorted list of folders in the specified directory.
listFolders
in file VFS.php, method VFS::listFolders()
    Returns a sorted list of folders in the specified directory.
listFolders
in file sql.php, method VFS_sql::listFolders()
    Returns a sorted list of folders in specified directory.
listFolders
in file smb.php, method VFS_smb::listFolders()
    Returns a sorted list of folders in specified directory.
listFolders
in file horde.php, method VFS_horde::listFolders()
    Returns a sorted list of folders in the specified directory.
listFolders
in file file.php, method VFS_file::listFolders()
    Returns a sorted list of folders in specified directory.
listFolders
in file kolab.php, method VFS_kolab::listFolders()
    Returns a sorted list of folders in the specified directory.
listFolders
in file ftp.php, method VFS_ftp::listFolders()
    Returns a sorted list of folders in the specified directory.
log
in file VFS.php, method 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.
ls
in file vfs.php, function ls()
    Lists the contents of the specified directory.
ListItem.php
procedural page ListItem.php
top

m

mergeOptions
in file vfs.php, function mergeOptions()
    Merges a set of options as returned by Console_Getopt::getopt2() into a single array.
move
in file ssh2.php, method VFS_ssh2::move()
    Moves a file through the backend.
move
in file VFS.php, method VFS::move()
    Moves a file through the backend.
move
in file sql_file.php, method VFS_sql_file::move()
    Moves a file in the database and the file system.
move
in file smb.php, method VFS_smb::move()
    Moves a file through the backend.
move
in file horde.php, method VFS_horde::move()
    Moves a file through the backend.
move
in file file.php, method VFS_file::move()
    Moves a file in the database and the file system.
move
in file ftp.php, method VFS_ftp::move()
    Moves a file through the backend.
musql.php
procedural page musql.php
top

o

Object.php
procedural page Object.php
top

r

read
in file ssh2.php, method VFS_ssh2::read()
    Retrieves a file from the VFS.
read
in file horde.php, method VFS_horde::read()
    Retrieves a file from the VFS.
read
in file sql.php, method VFS_sql::read()
    Retrieve a file from the VFS.
read
in file file.php, method VFS_file::read()
    Retrieve a file from the VFS.
read
in file Object.php, method VFS_Object::read()
    Retrieve a file from the VFS.
read
in file ftp.php, method VFS_ftp::read()
    Retrieves a file from the VFS.
read
in file kolab.php, method VFS_kolab::read()
    Retrieves a file from the VFS.
read
in file VFS.php, method VFS::read()
    Retrieves a file from the VFS.
read
in file smb.php, method VFS_smb::read()
    Retrieves a file from the VFS.
readByteRange
in file file.php, method VFS_file::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.
readByteRange
in file sql.php, method VFS_sql::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.
readByteRange
in file VFS.php, method 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.
readFile
in file ssh2.php, method VFS_ssh2::readFile()
    Retrieves a file from the VFS as an on-disk local file.
readFile
in file VFS.php, method VFS::readFile()
    Retrieves a file from the VFS as an on-disk local file.
readFile
in file smb.php, method VFS_smb::readFile()
    Retrieves a file from the VFS as an on-disk local file.
readFile
in file file.php, method VFS_file::readFile()
    Retrieves a file from the VFS as an on-disk local file.
readFile
in file ftp.php, method VFS_ftp::readFile()
    Retrieves a file from the VFS as an on-disk local file.
readStream
in file ftp.php, method VFS_ftp::readStream()
    Open a stream to a file in the VFS.
readStream
in file file.php, method VFS_file::readStream()
    Open a read-only stream to a file in the VFS.
readStream
in file smb.php, method VFS_smb::readStream()
    Open a stream to a file in the VFS.
readStream
in file ssh2.php, method VFS_ssh2::readStream()
    Open a stream to a file in the VFS.
rename
in file Object.php, method VFS_Object::rename()
    Rename a file in the VFS.
rename
in file ssh2.php, method VFS_ssh2::rename()
    Renames a file in the VFS.
rename
in file smb.php, method VFS_smb::rename()
    Renames a file in the VFS.
rename
in file file.php, method VFS_file::rename()
    Rename a file or folder in the VFS.
rename
in file VFS.php, method VFS::rename()
    Renames a file in the VFS.
rename
in file musql.php, method VFS_musql::rename()
    Renames a file or folder in the VFS.
rename
in file horde.php, method VFS_horde::rename()
    Renames a file in the VFS.
rename
in file sql.php, method VFS_sql::rename()
    Rename a file or folder in the VFS.
rename
in file ftp.php, method VFS_ftp::rename()
    Renames a file in the VFS.
rename
in file sql_file.php, method VFS_sql_file::rename()
    Rename a file or folder in the VFS.
top

s

setLogger
in file VFS.php, method VFS::setLogger()
    Sets the PEAR Log object used to log informational or error messages.
setParams
in file VFS.php, method VFS::setParams()
    Sets configuration parameters.
setParams
in file Object.php, method VFS_Object::setParams()
    Set configuration parameters.
setQuota
in file VFS.php, method VFS::setQuota()
    Sets the VFS quota limit.
setQuotaRoot
in file VFS.php, method VFS::setQuotaRoot()
    Sets the VFS quota root.
setVFSObject
in file Browser.php, method VFS_Browser::setVFSObject()
    Set the VFS object in the local object.
singleton
in file Object.php, method VFS_Object::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.
singleton
in file VFS.php, method 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.
size
in file ssh2.php, method VFS_ssh2::size()
    Returns the size of a file.
size
in file VFS.php, method VFS::size()
    Retrieves the size of a file from the VFS.
size
in file sql.php, method VFS_sql::size()
    Retrieves the filesize from the VFS.
size
in file horde.php, method VFS_horde::size()
    Retrieves the size of a file from the VFS.
size
in file ftp.php, method VFS_ftp::size()
    Returns the size of a file.
size
in file file.php, method VFS_file::size()
    Retrieves the filesize from the VFS.
strlen
in file VFS.php, method VFS::strlen()
    Returns the character (not byte) length of a string.
strtolower
in file VFS.php, method VFS::strtolower()
    Converts a string to all lowercase characters ignoring the current locale.
smb.php
procedural page smb.php
sql.php
procedural page sql.php
sql_file.php
procedural page sql_file.php
ssh2.php
procedural page ssh2.php
top

u

url2params
in file vfs.php, function url2params()
    Parses a URL into a set of parameters that can be used to instantiate a VFS object.
usage
in file vfs.php, function usage()
    Shows some error and usage information.
top

v

VFS
in file VFS.php, method VFS::VFS()
    Constructor.
VFS
in file VFS.php, class VFS
    VFS API for abstracted file storage and access.
vfs
in file vfs.php, function vfs()
    Returns a VFS instance.
VFS.php
procedural page VFS.php
vfs.php
procedural page vfs.php
VFS_Browser
in file Browser.php, class VFS_Browser
    Class for providing a generic UI for any VFS instance.
VFS_Browser
in file Browser.php, method VFS_Browser::VFS_Browser()
    Constructor
VFS_FILE
in file sql_file.php, constant VFS_FILE
    File value for vfs_type column.
VFS_file
in file file.php, method VFS_file::VFS_file()
    Constructs a new Filesystem based VFS object.
VFS_file
in file file.php, class VFS_file
    VFS implementation for a standard filesystem.
VFS_FLAG_READ
in file musql.php, constant VFS_FLAG_READ
    Permission for read access.
VFS_FLAG_WRITE
in file musql.php, constant VFS_FLAG_WRITE
    Permission for read access.
VFS_FOLDER
in file sql_file.php, constant VFS_FOLDER
    Folder value for vfs_type column.
VFS_ftp
in file ftp.php, class VFS_ftp
    VFS implementation for an FTP server.
VFS_GC
in file GC.php, class VFS_GC
    Class for providing garbage collection for any VFS instance.
VFS_horde
in file horde.php, class VFS_horde
    VFS implementation for the Horde Application Framework.
VFS_horde
in file horde.php, method VFS_horde::VFS_horde()
    Constructor.
VFS_kolab
in file kolab.php, class VFS_kolab
    VFS implementation for a Kolab IMAP server.
VFS_ListItem
in file ListItem.php, method VFS_ListItem::VFS_ListItem()
    Constructor
VFS_ListItem
in file ListItem.php, class VFS_ListItem
    An item returned from a folder list.
VFS_musql
in file musql.php, class VFS_musql
    Multi User VFS implementation for PHP's PEAR database abstraction layer.
VFS_Object
in file Object.php, method VFS_Object::VFS_Object()
    Constructor.
VFS_Object
in file Object.php, class VFS_Object
    A wrapper for the VFS class to return objects, instead of arrays.
VFS_QUOTA_METRIC_BYTE
in file VFS.php, constant VFS_QUOTA_METRIC_BYTE
VFS_QUOTA_METRIC_GB
in file VFS.php, constant VFS_QUOTA_METRIC_GB
VFS_QUOTA_METRIC_KB
in file VFS.php, constant VFS_QUOTA_METRIC_KB
VFS_QUOTA_METRIC_MB
in file VFS.php, constant VFS_QUOTA_METRIC_MB
VFS_smb
in file smb.php, class VFS_smb
    Stateless VFS implementation for a SMB server, based on smbclient.
VFS_sql
in file sql.php, class VFS_sql
    VFS implementation for PHP's PEAR database abstraction layer.
VFS_sql_file
in file sql_file.php, class VFS_sql_file
    VFS:: implementation using PHP's PEAR database abstraction layer and local file system for file storage.
VFS_ssh2
in file ssh2.php, class VFS_ssh2
    VFS implementation for an SSH2 server.
top

w

write
in file Object.php, method VFS_Object::write()
    Store a file in the VFS.
write
in file ssh2.php, method VFS_ssh2::write()
    Stores a file in the VFS.
write
in file file.php, method VFS_file::write()
    Store a file in the VFS, with the data copied from a temporary file.
write
in file smb.php, method VFS_smb::write()
    Stores a file in the VFS.
write
in file sql.php, method VFS_sql::write()
    Stores a file in the VFS.
write
in file sql_file.php, method VFS_sql_file::write()
    Store a file in the VFS, with the data copied from a temporary file.
write
in file kolab.php, method VFS_kolab::write()
    Stores a file in the VFS.
write
in file ftp.php, method VFS_ftp::write()
    Stores a file in the VFS.
write
in file VFS.php, method VFS::write()
    Stores a file in the VFS.
write
in file horde.php, method VFS_horde::write()
    Stores a file in the VFS.
writeData
in file VFS.php, method VFS::writeData()
    Stores a file in the VFS from raw data.
writeData
in file sql_file.php, method VFS_sql_file::writeData()
    Store a file in the VFS from raw data.
writeData
in file ssh2.php, method VFS_ssh2::writeData()
    Stores a file in the VFS from raw data.
writeData
in file Object.php, method VFS_Object::writeData()
    Store a file in the VFS from raw data.
writeData
in file ftp.php, method VFS_ftp::writeData()
    Stores a file in the VFS from raw data.
writeData
in file file.php, method VFS_file::writeData()
    Store a file in the VFS from raw data.
writeData
in file horde.php, method VFS_horde::writeData()
    Stores a file in the VFS from raw data.
writeData
in file musql.php, method VFS_musql::writeData()
    Stores a file in the VFS from raw data.
writeData
in file smb.php, method VFS_smb::writeData()
    Stores a file in the VFS from raw data.
writeData
in file sql.php, method VFS_sql::writeData()
    Store a file in the VFS from raw data.
top

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