Inherited Variables
Inherited Constants
Inherited Methods
Class: VFolder
- VFolder::copy()
- Copy a folder and the folders contents
- VFolder::create()
- Create a folder -- and all necessary parent folders.
- VFolder::delete()
- Delete a folder.
- VFolder::exists()
- Check if folder exists
- VFolder::files()
- Get file list
- VFolder::folders()
- Get folder list
- VFolder::getFileInstance()
- Get instance of File object
- VFolder::getInstance()
- Get instance of Folder object
- VFolder::is_empty()
- Test if folder is empty
- VFolder::listFolderTree()
- Get a folder tree
- VFolder::makeSafe()
- Makes path name safe to use.
- VFolder::mktemp()
- Make a temporary folder
- VFolder::move()
- Moves a folder.
Class: VFilesystemDriver
- VFilesystemDriver::__construct()
- Class Constructor
Class: VObject
- VObject::__construct()
- Class Constructor
- VObject::bind()
- Bind values to this object
- VObject::delete()
- Delete Object
- VObject::get()
- Get value
- VObject::getAll()
- Get all object values
- VObject::getError()
- Get error message
- VObject::getErrors()
- Get errors
- VObject::getMethods()
- Get object methods
- VObject::getProperties()
- Get object properties
- VObject::save()
- Save Object
- VObject::set()
- Set a value
- VObject::setError()
- Set error value
- VObject::setProperties()
- Set property values
- VObject::setProperty()
- Set property value
- VObject::toString()
- Convert object to string
- VObject::__destruct()
- Class Destructor
- VObject::__get()
- VObject::__isset()
- VObject::__set()
- VObject::__toString()
- Return object as a string
- VObject::__unset()
Class Details
Virtual Web Platform - FTP Folder Support
This class provides FTP Folder Support
Tags:
- author - Ralph Ritoch <rritoch@gmail.com>
- copyright - (c) Ralph Ritoch - All Rights Reserved
- link - VNetPublishing.Com
- license - VNETLPL Limited Public License
[ Top ]
Class Variables
$_client
[line 50]
FTP Client
Tags:
- var - FTP Client
- access - protected
Type: object
Overrides:
[ Top ]
$_vfile
[line 59]
FTP File
Tags:
- var - FTP File object
- access - protected
Type: object
Overrides:
[ Top ]
Class Methods
static getInstance
static VFTPFolder &getInstance(
object Client
&$client)
[line 141]
Get instance of Folder object
Tags:
- return - Folder object
- access - public
Overrides VFolder::getInstance() (Get instance of Folder object)
Parameters:
- object Client &$client -
[ Top ]
__construct
VFTPFolder __construct(
&$filesystem, VFilesystem
$filesystem)
[line 733]
Class constructor
Tags:
- access - public
Overrides VFilesystemDriver::__construct() (Class Constructor)
Parameters:
- VFilesystem $filesystem - Filesystem
- &$filesystem -
[ Top ]
copy
true|object True copy(
string
$src, string
$dest, [
$path = ''], [boolean
$force = false], [object
$sourceSystem = null])
[line 357]
Copy a folder and the folders contents
Tags:
- return - on success, error or warning otherwise
- access - public
Overrides VFolder::copy() (Copy a folder and the folders contents)
Parameters:
- string $src - Source folder
- string $dest - Destination folder
- boolean $force - Overwrite existing files
- object $sourceSystem - Source folder object
- $path -
[ Top ]
create
boolean create(
[string
$path = ''], [int
$mode = 0755])
[line 230]
Create a folder -- and all necessary parent folders.
Tags:
- return - True if successful.
- access - public
Overrides VFolder::create() (Create a folder -- and all necessary parent folders.)
Parameters:
- string $path - A path to create from the base path.
- int $mode - Directory permissions to set for folders created.
[ Top ]
delete
boolean delete(
string
$path)
[line 299]
Delete a folder.
Tags:
- return - True on success.
- access - public
Overrides VFolder::delete() (Delete a folder.)
Parameters:
- string $path - The path to the folder to delete.
[ Top ]
exists
boolean exists(
string
$path)
[line 487]
Check if folder exists
Tags:
- return - True if path is a folder
- access - public
Overrides VFolder::exists() (Check if folder exists)
Parameters:
- string $path - Folder path
[ Top ]
files
array files(
string
$path, [string
$filter = '.'], [boolean
$recurse = false], [boolean
$fullpath = false], [array
$exclude = array('.svn', 'CVS')])
[line 525]
Get file list
Tags:
- return - File list on success, error or warning otherwise
Overrides VFolder::files() (Get file list)
Parameters:
- string $path - Folder path
- string $filter - Folder regular expression filter
- boolean $recurse - Recurse into sub-folders
- boolean $fullpath - Return full path names
- array $exclude - Excluded folders
[ Top ]
folders
array folders(
string
$path, [string
$filter = '.'], [boolean
$recurse = false], [boolean
$fullpath = false], [array
$exclude = array('.svn', 'CVS')])
[line 591]
Get folder list
Tags:
- return - Folder list on success, error or warning otherwise
Overrides VFolder::folders() (Get folder list)
Parameters:
- string $path - Folder path
- string $filter - Folder regular expression filter
- boolean $recurse - Recurse into sub-folders
- boolean $fullpath - Return full path names
- array $exclude - Excluded folders
[ Top ]
getFileInstance
VFTPFile &getFileInstance(
)
[line 155]
Get instance of File object
Tags:
- return - File object
- access - public
Overrides VFolder::getFileInstance() (Get instance of File object)
Parameters:
[ Top ]
is_empty
boolean is_empty(
string
$path)
[line 699]
Test if folder is empty
Tags:
- return - True if path is empty
- access - public
Overrides VFolder::is_empty() (Test if folder is empty)
Parameters:
- string $path - Path
[ Top ]
listFolderTree
array listFolderTree(
string
$path, string
$filter, [
$maxLevel = 3], [integer
$level = 0], [mixed
$parent = 0], integer
$maxlevel)
[line 656]
Get a folder tree
Tags:
- return - Folder tree on success, error or warning otherwise
- access - public
Overrides VFolder::listFolderTree() (Get a folder tree)
Parameters:
- string $path - Folder path
- string $filter - Regular expression filter
- integer $maxlevel - Maximum depth to recurse into
- integer $level - Current level
- mixed $parent - Parent folder
- $maxLevel -
[ Top ]
makeSafe
string makeSafe(
string
$path)
[line 719]
Makes path name safe to use.
Tags:
- return - The sanitised string.
- access - public
Overrides VFolder::makeSafe() (Makes path name safe to use.)
Parameters:
- string $path - The full path to sanitise.
[ Top ]
mktemp
string|object Folder mktemp(
[string
$prefix = 'php'], [string
$dir = false])
[line 70]
Make a temporary folder
Tags:
- return - name on success, error or warning otherwise
- access - public
Overrides VFolder::mktemp() (Make a temporary folder)
Parameters:
- string $prefix - Folder name prefix
- string $dir - Directory to create file
[ Top ]
move
mixed move(
string
$src, string
$dest, [string
$path = ''])
[line 449]
Moves a folder.
Tags:
- return - True on success, error or warning otherwise
- access - public
Overrides VFolder::move() (Moves a folder.)
Parameters:
- string $src - The path to the source folder.
- string $dest - The path to the destination folder.
- string $path - An optional base path to prefix to the file names.
[ Top ]