Class: VFS_smb

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

Class Overview

VFS
   |
   --VFS_smb

Stateless VFS implementation for a SMB server, based on smbclient.

Author(s):

Patrice Levesque <wayne at ptaff.ca>
Paul Gareau <paul at xhawk.net>

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 39]
Stateless VFS implementation for a SMB server, based on smbclient.

Required values for $params:

   'username'  - The username with which to connect to the SMB server.
   'password'  - The password with which to connect to the SMB server.
   'hostspec'  - The SMB server to connect to.
   'port'      - The SMB port number to connect to.
   'share'     - The share to access on the SMB server.
   'smbclient' - The path to the 'smbclient' executable.

Optional values for $params:

   'ipaddress' - The address of the server to connect to.

Functions not implemented:

changePermissions(): The SMB permission style does not fit with the module.

$Horde: framework/VFS/lib/VFS/smb.php,v 1.1.2.5 2009/02/06 18:24:20 slusarz Exp $

Codebase copyright 2002 Paul Gareau <paul@xhawk.net>. Adapted with permission by Patrice Levesque <wayne@ptaff.ca> from phpsmb-0.8 code, and converted to the LGPL. Please do not taunt original author, contact Patrice Levesque or dev@lists.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.

Author: Patrice Levesque <wayne@ptaff.ca>
Author: Paul Gareau <paul@xhawk.net>
Since: Horde 3.1

[ Top ]

Method Detail

copy [line 507]

boolean|PEAR_Error copy(
string
$path, string
$name, string
$dest, [boolean
$autocreate = false])

Copies a file through the backend.

Return: True on success or a PEAR_Error on failure.

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

Parameters:

string	`$path`	—	The path to store the file in.
string	`$name`	—	The filename to use.
string	`$dest`	—	The destination of the file.
boolean	`$autocreate`	—	Automatically create directories?

[ Top ]

createFolder [line 354]

boolean|PEAR_Error createFolder(
string
$path, string
$name)

Creates a folder on the VFS.

Return: True on success or a PEAR_Error on failure.

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

Parameters:

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

[ Top ]

deleteFile [line 213]

boolean|PEAR_Error deleteFile(
string
$path, string
$name)

Deletes a file from the VFS.

Return: True on success or a PEAR_Error on failure.

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

Parameters:

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

[ Top ]

deleteFolder [line 258]

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

Deletes a folder from the VFS.

Return: True on success or a PEAR_Error on failure.

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

Parameters:

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

[ Top ]

isFolder [line 238]

boolean isFolder(
string
$path, string
$name)

Checks if a given pathname is a folder.

Return: True if it is a folder, false otherwise.

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

Parameters:

string	`$path`	—	The path to the folder.
string	`$name`	—	The file or folder name.

[ Top ]

listFolder [line 387]

boolean|PEAR_Error listFolder(
[string
$path = ''], [mixed
$filter = null], [boolean
$dotfiles = true], [boolean
$dironly = false])

Returns an unsorted file list.

Return: File list on success or a PEAR_Error on failure.

Overrides VFS::listFolder() (Returns a file list of the directory passed in.)

Parameters:

string	`$path`	—	The path of the directory to get the file list for.
mixed	`$filter`	—	Hash of items to filter based on filename.
boolean	`$dotfiles`	—	Show dotfiles? This is irrelevant with smbclient.
boolean	`$dironly`	—	Show directories only?

[ Top ]

listFolders [line 468]

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

Returns a sorted list of folders in specified directory.

Return: Folder list on success or a PEAR_Error 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`	—	Hash of items to filter based on folderlist.
boolean	`$dotfolders`	—	Include dotfolders? Irrelevant for SMB.

[ Top ]

move [line 562]

boolean|PEAR_Error move(
string
$path, string
$name, string
$dest, [boolean
$autocreate = false])

Moves a file through the backend.

Return: True on success or a PEAR_Error on failure.

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

Parameters:

string	`$path`	—	The path to store the file in.
string	`$name`	—	The filename to use.
string	`$dest`	—	The destination of the file.
boolean	`$autocreate`	—	Automatically create directories?

[ Top ]

read [line 83]

string read(
string
$path, string
$name)

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

readFile [line 110]

string readFile(
string
$path, string
$name)

Retrieves a file from the VFS as an on-disk local file.

This function provides a file on local disk with the data of a VFS file in it. This file <em>cannot</em> be modified! The behavior if you do modify it is undefined. It will be removed at the end of the request.

Return: A local filename.

Overrides VFS::readFile() (Retrieves a file from the VFS as an on-disk local file.)

Parameters:

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

[ Top ]

readStream [line 141]

resource readStream(
string
$path, string
$name)

Open a stream to a file in the VFS.

Return: The stream.

Parameters:

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

[ Top ]

rename [line 312]

boolean|PEAR_Error rename(
string
$oldpath, string
$oldname, string
$newpath, string
$newname)

Renames a file in the VFS.

Return: True on success or a PEAR_Error on failure.

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 ]

write [line 163]

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

Stores a file in the VFS.

Return: True on success or a PEAR_Error 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 194]

boolean|PEAR_Error 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 on failure.

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 ]