Class: VFS_musql

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

Class Overview

VFS
   |
   --VFS_sql
      |
      --VFS_musql

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

Author(s):

Chuck Hagenbuch <chuck at horde.org>
Mike Cochrane <mike at graftonhall.co.nz>

Inherited Variables

Inherited Methods

Class: VFS_sql

VFS_sql::createFolder(): Creates a folder on the VFS.
VFS_sql::deleteFile(): Delete a file from the VFS.
VFS_sql::deleteFolder(): Delete a folder from the VFS.
VFS_sql::gc(): Garbage collect files in the VFS storage system.
VFS_sql::getFolderSize(): Returns the size of a file.
VFS_sql::isFolder(): VFS_sql override of isFolder() to check for root folder.
VFS_sql::listFolders(): Returns a sorted list of folders in specified directory.
VFS_sql::read(): Retrieve a file from the VFS.
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.
VFS_sql::rename(): Rename a file or folder in the VFS.
VFS_sql::size(): Retrieves the filesize from the VFS.
VFS_sql::write(): Stores a file in the VFS.
VFS_sql::writeData(): Store a file in the VFS from raw data.

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 69]
Multi User 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_muvfs'.

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.

Known Issues: Delete is not recusive, so files and folders that used to be in a folder that gets deleted live forever in the database, or re-appear when the folder is recreated. Rename has the same issue, so files are lost if a folder is renamed.

The table structure for the VFS can be found in data/muvfs.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/musql.php,v 1.1.2.4 2009/01/06 15:23:47 jan 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>
Author: Mike Cochrane <mike@graftonhall.co.nz>

[ Top ]

Method Detail

changePermissions [line 508]

mixed changePermissions(
string
$path, string
$name, 
$permission)

Changes permissions for an Item on the VFS.

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

Overrides VFS::changePermissions() (Changes permissions for an item on the VFS.)

Parameters:

string	`$path`	—	Holds the path of directory of the Item.
string	`$name`	—	Holds the name of the Item.
	`$permission`	—

[ Top ]

createFolder [line 283]

mixed createFolder(
string
$path, string
$name)

Creates a folder on the VFS.

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

Overrides VFS_sql::createFolder() (Creates a folder on 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 160]

mixed deleteFile(
string
$path, string
$name)

Deletes a file from the VFS.

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

Overrides VFS_sql::deleteFile() (Delete a file from the VFS.)

Parameters:

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

[ Top ]

deleteFolder [line 352]

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

Deletes a folder from the VFS.

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

Overrides VFS_sql::deleteFolder() (Delete a folder from the VFS.)

Parameters:

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

[ Top ]

rename [line 217]

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

Renames a file or folder in the VFS.

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

Overrides VFS_sql::rename() (Rename a file or folder 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 ]

writeData [line 92]

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.

Overrides VFS_sql::writeData() (Store 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 ]