Class: VFS_sql

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

Class Overview

VFS
   |
   --VFS_sql

VFS implementation for PHP's PEAR database abstraction layer.

Author(s):

Chuck Hagenbuch <chuck at horde.org>

Methods

Child classes:

VFS_musql: Multi User VFS implementation for PHP's PEAR database abstraction layer.

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 65]
VFS implementation for PHP's PEAR database abstraction layer.

Required values for $params:

   'phptype'      The database type (ie. 'pgsql', 'mysql', etc.).

Optional values:

   'table'          The name of the vfs table in 'database'. Defaults to
                    'horde_vfs'.

Required by some database implementations:

   'hostspec'     The hostname of the database server.
   'protocol'     The communication protocol ('tcp', 'unix', etc.).
   'database'     The name of the database.
   'username'     The username with which to connect to the database.
   'password'     The password associated with 'username'.
   'options'      Additional options to pass to the database.
   'tty'          The TTY on which to connect to the database.
   'port'         The port on which to connect to the database.

Optional values when using separate reading and writing servers, for example in replication settings:

   'splitread'   Boolean, whether to implement the separation or not.
   'read'        Array containing the parameters which are different for
                 the read database connection, currently supported
                 only 'hostspec' and 'port' parameters.

The table structure for the VFS can be found in data/vfs.sql.

Database specific notes:

MSSQL:

 - The vfs_data field must be of type IMAGE.
 - You need the following php.ini settings:
    ; Valid range 0 - 2147483647. Default = 4096.
    mssql.textlimit = 0 ; zero to pass through

    ; Valid range 0 - 2147483647. Default = 4096.
    mssql.textsize = 0 ; zero to pass through

$Horde: framework/VFS/lib/VFS/sql.php,v 1.1.2.6 2009/02/13 05:45:19 chuck Exp $

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

Author: Chuck Hagenbuch <chuck@horde.org>

[ Top ]

Method Detail

createFolder [line 411]

mixed createFolder(
string
$path, string
$name)

Creates a folder on the VFS.

Return: True on success or a PEAR_Error object on failure.

Overridden in child classes as:

VFS_musql::createFolder(): Creates a folder on the VFS.

Overrides VFS::createFolder() (Creates a folder in the VFS.)

Parameters:

string	`$path`	—	Holds the path of directory to create folder.
string	`$name`	—	Holds the name of the new folder.

[ Top ]

deleteFile [line 322]

mixed deleteFile(
string
$path, string
$name)

Delete a file from the VFS.

Return: True on success or a PEAR_Error object on failure.

Overridden in child classes as:

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

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

Parameters:

string	`$path`	—	The path to store the file in.
string	`$name`	—	The filename to use.

[ Top ]

deleteFolder [line 442]

mixed deleteFolder(
string
$path, string
$name, [boolean
$recursive = false])

Delete a folder from the VFS.

Return: True on success or a PEAR_Error object on failure.

Overridden in child classes as:

VFS_musql::deleteFolder(): Deletes a folder from the VFS.

Overrides VFS::deleteFolder() (Deletes a folder from the VFS.)

Parameters:

string	`$path`	—	The path of the folder.
string	`$name`	—	The folder name to use.
boolean	`$recursive`	—	Force a recursive delete?

[ Top ]

gc [line 669]

void gc(
string
$path, [integer
$secs = 345600])

Garbage collect files in the VFS storage system.

Parameters:

string	`$path`	—	The VFS path to clean.
integer	`$secs`	—	The minimum amount of time (in seconds) required before a file is removed.

[ Top ]

getFolderSize [line 133]

integer getFolderSize(
[string
$path = null], [string
$name = null])

Returns the size of a file.

Return: The size of the folder in bytes or PEAR_Error on failure.
Access: public

Overrides VFS::getFolderSize() (Returns the size of a folder)

Parameters:

string	`$path`	—	The path of the file.
string	`$name`	—	The filename.

[ Top ]

isFolder [line 1109]

boolean isFolder(
string
$path, string
$name)

VFS_sql override of isFolder() to check for root folder.

Return: True if $path/$name is a folder

Overrides VFS::isFolder() (Checks if a given item is a folder.)

Parameters:

string	`$path`	—	Path to possible folder
string	`$name`	—	Name of possible folder

[ Top ]

listFolders [line 599]

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

Returns a sorted list of folders in specified directory.

Return: Folder list on success or PEAR_Error object on failure.

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`	—	String/hash of items to filter based on folderlist.
boolean	`$dotfolders`	—	Include dotfolders?

[ Top ]

read [line 162]

string read(
string
$path, string
$name)

Retrieve a file from the VFS.

Return: The file data.

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

Parameters:

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

[ Top ]

readByteRange [line 192]

string readByteRange(
string
$path, string
$name, 
&$offset, [integer
$length = -1], 
&$remaining, integer
$offset, integer
$remaining)

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.

Return: The file data.

Overrides 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.)

Parameters:

string	`$path`	—	The pathname to the file.
string	`$name`	—	The filename to retrieve.
integer	`$offset`	—	The offset of the part. (The new offset will be stored in here).
integer	`$length`	—	The length of the part. If the length = -1, the whole part after the offset is retrieved. If more bytes are given as exists after the given offset. Only the available bytes are read.
integer	`$remaining`	—	The bytes that are left, after the part that is retrieved.
	`&$offset`	—
	`&$remaining`	—

[ Top ]

rename [line 360]

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

Rename a file or folder in the VFS.

Return: True on success or a PEAR_Error object on failure.

Overridden in child classes as:

VFS_musql::rename(): Renames a file or folder in the VFS.

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 98]

int size(
string
$path, string
$name)

Retrieves the filesize from the VFS.

Return: The file size.

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 231]

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.

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 251]

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

Store a file in the VFS from raw data.

Return: True on success or a PEAR_Error object on failure.

Overridden in child classes as:

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

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 ]