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


Classes:
VFS
VFS_Browser
VFS_file
VFS_ftp
VFS_GC
VFS_horde
VFS_kolab
VFS_ListItem
VFS_musql
VFS_Object
VFS_smb
VFS_sql
VFS_sql_file
VFS_ssh2
Files:
Browser.php
file.php
ftp.php
GC.php
horde.php
kolab.php
ListItem.php
musql.php
Object.php
smb.php
sql.php
sql_file.php
ssh2.php
VFS.php
vfs.php

Class: VFS_ftp

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

Class Overview

VFS
   |
   --VFS_ftp

VFS implementation for an FTP server.


Author(s):

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::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 43]
VFS implementation for an FTP server.

Required values for $params:

      'username'       The username with which to connect to the ftp server.
      'password'       The password with which to connect to the ftp server.
      'hostspec'       The ftp server to connect to.

Optional values for $params:

      'lsformat'       The return formatting from the 'ls' command).
                       Values: 'aix', 'standard' (default)
      'maplocalids'    If true and the POSIX extension is available, the
                       driver will map the user and group IDs returned from
                       the FTP server with the local IDs from the local
                       password file.  This is useful only if the FTP server
                       is running on localhost or if the local user/group
                       IDs are identical to the remote FTP server.
      'pasv'           If true, connection will be set to passive mode.
      'port'           The port used to connect to the ftp server if other
                       than 21.
      'ssl'            If true, and PHP had been compiled with OpenSSL
                       support, TLS transport-level encryption will be
                       negotiated with the server.
      'timeout'        If defined, use this value as the timeout for the
                       server.
      'type'           The type of the remote FTP server.
                       Possible values: 'unix', 'win', 'netware'
                       By default, we attempt to auto-detect type.

$Horde: framework/VFS/lib/VFS/ftp.php,v 1.1.2.7 2009/10/15 17:18:48 jan Exp $

Copyright 2002-2009 The Horde Project (http://www.horde.org/) Copyright 2002-2007 Michael Varghese <mike.varghese@ascellatech.com>

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



[ Top ]

Method Detail

changePermissions   [line 432]

mixed changePermissions( string $path, string $name, string $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   —  The parent folder of the item.
string   $name   —  The name of the item.
string   $permission   —  The permission to set.

[ Top ]

copy   [line 745]

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

Copies a file through the backend.
  • Return: True on success or a PEAR_Error object on failure.

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

Parameters:

string   $path   —  The path of the original file.
string   $name   —  The name of the original file.
string   $dest   —  The name of the destination directory.
boolean   $autocreate   —  Automatically create directories?

[ Top ]

createFolder   [line 409]

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::createFolder() (Creates a folder in the VFS.)

Parameters:

string   $path   —  The parent folder.
string   $name   —  The name of the new folder.

[ Top ]

deleteFile   [line 268]

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::deleteFile() (Deletes a file from the VFS.)

Parameters:

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

[ Top ]

deleteFolder   [line 324]

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::deleteFolder() (Deletes a folder from the VFS.)

Parameters:

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

[ Top ]

getCurrentDirectory   [line 853]

string getCurrentDirectory( )

Returns the current working directory on the FTP server.
  • Return: The current working directory.

Overrides VFS::getCurrentDirectory() (Returns the current working directory of the VFS backend.)
[ Top ]

isFolder   [line 295]

boolean isFolder( string $path, string $name)

Checks if a given item 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 parent folder.
string   $name   —  The item name.

[ Top ]

listFolders   [line 702]

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

Returns a sorted list of folders in the specified directory.
  • Return: Folder list on success or a 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   —  Hash of items to filter based on folderlist.
boolean   $dotfolders   —  Include dotfolders?

[ Top ]

move   [line 812]

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

Moves a file through the backend.
  • Return: True on success or a PEAR_Error object on failure.

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

Parameters:

string   $path   —  The path of the original file.
string   $name   —  The name of the original file.
string   $dest   —  The destination file name.
boolean   $autocreate   —  Automatically create directories?

[ Top ]

read   [line 120]

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

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

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

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

Renames a file in the VFS.
  • Return: True on success or a PEAR_Error object 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 ]

size   [line 98]

integer size( string $path, string $name)

Returns the size of a file.
  • Return: The size of the file in bytes or PEAR_Error on failure.
  • Access: public

Overrides VFS::size() (Retrieves the size of a file from the VFS.)

Parameters:

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

[ Top ]

write   [line 204]

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

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::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 ]
Documentation generated on Mon, 11 Mar 2019 15:34:53 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright © PHP Group 2004.