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


Classes:
VFS
VFS_Browser
VFS_file
VFS_ftp
VFS_GC
VFS_ListItem
VFS_musql
VFS_Object
VFS_sql
VFS_sql_file
Files:
Browser.php
file.php
ftp.php
GC.php
ListItem.php
musql.php
Object.php
sql.php
sql_file.php
VFS.php
vfs.php

Class: VFS_file

Source Location: /VFS-0.0.5/VFS/file.php

Class Overview

VFS
   |
   --VFS_file

VFS implementation for a standard filesystem.


Author(s):

  • Chuck Hagenbuch

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::deleteFile()
Deletes a file from the VFS.
VFS::deleteFolder()
Deletes a folder from the VFS.
VFS::emptyFolder()
Removes recursively 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::getModifiablePermissions()
Returns an array specifying what permissions are changeable for this VFS implementation.
VFS::getParam()
Returns configuration parameters.
VFS::getRequiredCredentials()
Returns the list of additional credentials required, if any.
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::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::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::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::_listFolder()
Returns an an unsorted file list of the specified directory.

Class Details

[line 25]
VFS implementation for a standard filesystem.

 Required values for $params:
      'vfsroot'       The root path

Note: The user that your webserver runs as (commonly 'nobody', 'apache', or 'www-data') MUST have read/write permission to the directory you specific as the 'vfsroot'.

$Horde: framework/VFS/VFS/file.php,v 1.66 2005/03/28 17:24:21 chuck Exp $

Copyright 2002-2005 Chuck Hagenbuch <chuck@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: Chuck Hagenbuch
  • Since: Horde 2.2


[ Top ]

Method Detail

VFS_file (Constructor)   [line 46]

VFS_file VFS_file( [optional $params = array()])

Constructs a new Filesystem based VFS object.
  • Access: public

Parameters:

optional   $params   —  array $params A hash containing connection parameters.

[ Top ]

changePermissions   [line 327]

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

Changes permissions for an item in the VFS.
  • Return: True on success or a PEAR_Error object on failure.
  • Access: public

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

Parameters:

string   $path   —  The path of directory of the item.
string   $name   —  The name of the item.
integer   $permission   —  The octal value of the new permission.

[ Top ]

copy   [line 161]

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.
  • Access: public

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.

[ Top ]

createFolder   [line 292]

mixed createFolder( string $path, string $name)

Creates a folder on the VFS.
  • Return: True on success or a PEAR_Error object on failure.
  • Access: public

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

Parameters:

string   $path   —  The path to delete the folder from.
string   $name   —  The foldername to use.

[ Top ]

deleteFile   [line 239]

mixed deleteFile( string $path, string $name)

Delete a file from the VFS.
  • Return: True on success or a PEAR_Error object on failure.
  • Access: public

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

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

Delete a folder from the VFS.
  • Return: True on success or a PEAR_Error object on failure.
  • Access: public

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

Parameters:

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

[ Top ]

isFolder   [line 311]

boolean isFolder( string $path, string $name)

Check if a given pathname is a folder.
  • Return: True if it is a folder, false otherwise.
  • Access: public

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

Parameters:

string   $path   —  The path to the folder.
string   $name   —  The file/folder name.

[ Top ]

listFolders   [line 479]

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

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

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

Parameters:

optional   $path   —  string $path The path of the directory to get the directory list for.
optional   $filter   —  mixed $filter Hash of items to filter based on folderlist.
optional   $dotfolders   —  boolean $dotfolders Include dotfolders?

[ Top ]

move   [line 134]

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

Moves a file in the database and the file system.
  • Return: True on success or a PEAR_Error object on failure.
  • Access: public

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.
   $dest   — 

[ Top ]

read   [line 68]

string read( string $path, string $name)

Retrieve a file from the VFS.
  • Return: The file data.
  • Access: public

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

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.
  • Access: public

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

mixed write( string $path, string $name, string $tmpFile, [optional $autocreate = true])

Store a file in the VFS, with the data copied from a temporary file.
  • Return: True on success or a PEAR_Error object on failure.
  • Access: public

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.
optional   $autocreate   —  boolean $autocreate Automatically create directories?

[ Top ]

writeData   [line 193]

mixed writeData( string $path, string $name, string $data, [optional $autocreate = true])

Store a file in the VFS from raw data.
  • Return: True on success or a PEAR_Error object on failure.
  • Access: public

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.
optional   $autocreate   —  boolean $autocreate Automatically create directories?

[ Top ]

_listFolder   [line 349]

array _listFolder( string $path, [optional $filter = null], [optional $dotfiles = true], [optional $dironly = false])

Return a list of the contents of a folder.
  • Return: File list on success, PEAR_Error on error.
  • Access: public

Overrides VFS::_listFolder() (Returns an an unsorted file list of the specified directory.)

Parameters:

string   $path   —  The path of the directory.
optional   $filter   —  mixed $filter String/hash to filter file/dirname on.
optional   $dotfiles   —  boolean $dotfiles Show dotfiles?
optional   $dironly   —  boolean $dironly Show only directories?

[ Top ]
Documentation generated on Mon, 11 Mar 2019 14:31:24 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.