Constructs a new Filesystem based VFS object.
VFS_file
VFS_file
([array $params = array()])
-
array
$params: A hash containing connection parameters.
Changes permissions for an item in the VFS.
mixed
changePermissions
(string $path, string $name, integer $permission)
-
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.
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 to store the file in.
-
string
$name: The filename to use.
-
string
$dest: The destination of the file.
-
boolean
$autocreate: Automatically create directories?
Redefinition of:
- VFS::copy()
- Copies a file through the backend.
Redefined in descendants as:
Creates a folder on the VFS.
mixed
createFolder
(string $path, string $name)
-
string
$path: The path to create the folder in.
-
string
$name: The foldername to use.
Redefinition of:
- VFS::createFolder()
- Creates a folder in the VFS.
Redefined in descendants as:
Delete a file from the VFS.
mixed
deleteFile
(string $path, string $name)
-
string
$path: The path to store the file in.
-
string
$name: The filename to use.
Redefinition of:
- VFS::deleteFile()
- Deletes a file from the VFS.
Redefined in descendants as:
Delete a folder from the VFS.
mixed
deleteFolder
(string $path, string $name, [boolean $recursive = false])
-
string
$path: The path to delete the folder from.
-
string
$name: The foldername to use.
-
boolean
$recursive: Force a recursive delete?
Redefinition of:
- VFS::deleteFolder()
- Deletes a folder from the VFS.
Redefined in descendants as:
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.
Check if a given pathname is a folder.
boolean
isFolder
(string $path, string $name)
-
string
$path: The path to the folder.
-
string
$name: The file/folder name.
Redefinition of:
- VFS::isFolder()
- Checks if a given item is a folder.
Returns a sorted list of folders in 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.
Redefined in descendants as:
Moves a file in the database and the file system.
mixed
move
(string $path, string $name, string $dest, [boolean $autocreate = false])
-
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?
Redefinition of:
- VFS::move()
- Moves a file through the backend.
Redefined in descendants as:
Retrieve 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 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.
string
readByteRange
(string $path, string $name, &$offset, [integer $length = -1], &$remaining, integer $offset, integer $remaining)
-
string
$path: The pathname to the file.
-
string
$name: The filename to retrieve.
-
integer
$offset: The offset of the part. (The new offset will be stored in here).
-
integer
$length: The length of the part. If the length = -1, the whole part after the offset is retrieved. If more bytes are given as exists after the given offset. Only the available bytes are read.
-
integer
$remaining: The bytes that are left, after the part that is retrieved.
-
&$offset
-
&$remaining
Redefinition of:
- 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.
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 read-only 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.
Rename a file or folder 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.
Redefined in descendants as:
Retrieves the filesize from the VFS.
integer
size
(string $path, string $name)
-
string
$path: The pathname to the file.
-
string
$name: The filename to retrieve.
Redefinition of:
- VFS::size()
- Retrieves the size of a file from the VFS.
Store a file in the VFS, with the data copied from a temporary file.
mixed
write
(string $path, string $name, string $tmpFile, [boolean $autocreate = true])
-
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.
Redefined in descendants as:
Store a file in the VFS from raw data.
mixed
writeData
(string $path, string $name, string $data, [boolean $autocreate = true])
-
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.
Redefined in descendants as:
Return a list of the contents of a folder.
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.
Redefined in descendants as:
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()