Changes permissions for an item on the VFS.
mixed
changePermissions
(string $path, string $name, string $permission)
-
string
$path: The parent folder of the item.
-
string
$name: The name of the item.
-
string
$permission: The permission to set.
Redefinition of:
- VFS::changePermissions()
- Changes permissions for an item on the VFS.
Copies a file through the backend.
mixed
copy
(string $path, string $name, string $dest, [boolean $autocreate = false])
-
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: Auto-create the directory if it doesn't exist?
Redefinition of:
- VFS::copy()
- Copies a file through the backend.
Creates a folder on the VFS.
mixed
createFolder
(string $path, string $name)
-
string
$path: The parent folder.
-
string
$name: The name of the new folder.
Redefinition of:
- VFS::createFolder()
- Creates a folder in the VFS.
Deletes a file from the VFS.
mixed
deleteFile
(string $path, string $name)
-
string
$path: The path to delete the file from.
-
string
$name: The filename to delete.
Redefinition of:
- VFS::deleteFile()
- Deletes a file from the VFS.
Deletes a folder from the VFS.
mixed
deleteFolder
(string $path, string $name, [boolean $recursive = false])
-
string
$path: The parent folder.
-
string
$name: The name of the folder to delete.
-
boolean
$recursive: Force a recursive delete?
Redefinition of:
- VFS::deleteFolder()
- Deletes a folder from the VFS.
Returns if a given file or folder exists in a folder.
boolean
exists
(string $path, string $name)
-
string
$path: The path to the folder.
-
string
$name: The file or folder name.
Redefinition of:
- VFS::exists()
- Returns if a given file or folder exists in a folder.
Returns the current working directory on the SSH2 server.
string
getCurrentDirectory
()
Redefinition of:
- VFS::getCurrentDirectory()
- Returns the current working directory of the VFS backend.
Checks if a given item is a folder.
boolean
isFolder
(string $path, string $name)
-
string
$path: The parent folder.
-
string
$name: The item name.
Redefinition of:
- VFS::isFolder()
- Checks if a given item is a folder.
Returns a sorted list of folders in the specified directory.
mixed
listFolders
([string $path = ''], [mixed $filter = null], [boolean $dotfolders = true])
-
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?
Redefinition of:
- VFS::listFolders()
- Returns a sorted list of folders in the specified directory.
Moves a file through the backend.
mixed
move
(string $path, string $name, string $dest, [boolean $autocreate = false])
-
string
$path: The path of the original file.
-
string
$name: The name of the original file.
-
string
$dest: The destination file name.
-
boolean
$autocreate: Auto-create the directory if it doesn't exist?
Redefinition of:
- VFS::move()
- Moves a file through the backend.
Retrieves a file from the VFS.
string
read
(string $path, string $name)
-
string
$path: The pathname to the file.
-
string
$name: The filename to retrieve.
Redefinition of:
- VFS::read()
- Retrieves a file from the VFS.
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.
string
readFile
(string $path, string $name)
-
string
$path: The pathname to the file.
-
string
$name: The filename to retrieve.
Redefinition of:
- VFS::readFile()
- Retrieves a file from the VFS as an on-disk local file.
Open a stream to a file in the VFS.
resource
readStream
(string $path, string $name)
-
string
$path: The pathname to the file.
-
string
$name: The filename to retrieve.
Renames a file in the VFS.
mixed
rename
(string $oldpath, string $oldname, string $newpath, string $newname)
-
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.
Redefinition of:
- VFS::rename()
- Renames a file in the VFS.
Returns the size of a file.
integer
size
(string $path, string $name)
-
string
$path: The path of the file.
-
string
$name: The filename.
Redefinition of:
- VFS::size()
- Retrieves the size of a file from the VFS.
Stores a file in the VFS.
mixed
write
(string $path, string $name, string $tmpFile, [boolean $autocreate = false])
-
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?
Redefinition of:
- VFS::write()
- Stores a file in the VFS.
Stores a file in the VFS from raw data.
mixed
writeData
(string $path, string $name, string $data, [boolean $autocreate = false])
-
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?
Redefinition of:
- VFS::writeData()
- Stores a file in the VFS from raw data.
Returns an an unsorted file list of the specified directory.
array
_listFolder
([string $path = ''], [mixed $filter = null], [boolean $dotfiles = true], [boolean $dironly = false])
-
string
$path: The path of the directory.
-
mixed
$filter: String/hash to filter file/dirname on.
-
boolean
$dotfiles: Show dotfiles?
-
boolean
$dironly: Show only directories?
Redefinition of:
- VFS::_listFolder()
- Returns an an unsorted file list of the specified directory.
Inherited Methods
Inherited From VFS
VFS::VFS()
VFS::autocreatePath()
VFS::changePermissions()
VFS::checkCredentials()
VFS::copy()
VFS::createFolder()
VFS::delete()
VFS::deleteFile()
VFS::deleteFolder()
VFS::emptyFolder()
VFS::exists()
VFS::factory()
VFS::getCurrentDirectory()
VFS::getFolderSize()
VFS::getModifiablePermissions()
VFS::getParam()
VFS::getQuota()
VFS::getRequiredCredentials()
VFS::getVFSSize()
VFS::isFolder()
VFS::listFolder()
VFS::listFolders()
VFS::log()
VFS::move()
VFS::read()
VFS::readByteRange()
VFS::readFile()
VFS::rename()
VFS::setLogger()
VFS::setParams()
VFS::setQuota()
VFS::setQuotaRoot()
VFS::singleton()
VFS::size()
VFS::strlen()
VFS::strtolower()
VFS::write()
VFS::writeData()
VFS::_copyRecursive()
VFS::_getPath()
VFS::_getTempDir()
VFS::_getTempFile()
VFS::_listFolder()