FolderWrapper
Wrapper class for Folder
since |
3.4 |
---|---|
deprecated |
4.0 Use \Joomla\CMS\Filesystem\Folder instead |
Methods
copy
Helper wrapper method for copy
copy(string $src, string $dest, string $path = '', boolean $force = false, boolean $useStreams = false) : boolean
see | \Joomla\CMS\Filesystem\Folder::copy() |
---|---|
since |
3.4 |
throws |
|
deprecated |
4.0 Use \Joomla\CMS\Filesystem\Folder instead |
Arguments
- $src
string
The path to the source folder.- $dest
string
The path to the destination folder.- $path
string
An optional base path to prefix to the file names.- $force
boolean
Force copy.- $useStreams
boolean
Optionally force folder/file overwrites.
Response
boolean
True on success.
create
Helper wrapper method for create
create(string $path = '', integer $mode = 493) : boolean
see | \Joomla\CMS\Filesystem\Folder::create() |
---|---|
since |
3.4 |
deprecated |
4.0 Use \Joomla\CMS\Filesystem\Folder instead |
Arguments
- $path
string
A path to create from the base path.- $mode
integer
Directory permissions to set for folders created. 0755 by default.
Response
boolean
True if successful.
delete
Helper wrapper method for delete
delete(string $path) : boolean
see | \Joomla\CMS\Filesystem\Folder::delete() |
---|---|
since |
3.4 |
throws |
|
deprecated |
4.0 Use \Joomla\CMS\Filesystem\Folder instead |
Arguments
- $path
string
The path to the folder to delete.
Response
boolean
True on success.
exists
Helper wrapper method for exists
exists(string $path) : boolean
see | \Joomla\CMS\Filesystem\Folder::exists() |
---|---|
since |
3.4 |
deprecated |
4.0 Use \Joomla\CMS\Filesystem\Folder instead |
Arguments
- $path
string
Folder name relative to installation dir.
Response
boolean
True if path is a folder.
files
Helper wrapper method for files
files(string $path, string $filter = '.', mixed $recurse = false, boolean $full = false, array $exclude = array('.svn', 'CVS', '.DS_Store', '__MACOSX'), array $excludefilter = array('^\..*', '.*~'), boolean $naturalSort = false) : array
see | \Joomla\CMS\Filesystem\Folder::files() |
---|---|
since |
3.4 |
deprecated |
4.0 Use \Joomla\CMS\Filesystem\Folder instead |
Arguments
- $path
string
The path of the folder to read.- $filter
string
A filter for file names.- $recurse
mixed
True to recursively search into sub-folders, or an integer to specify the maximum depth.- $full
boolean
True to return the full path to the file.- $exclude
array
Array with names of files which should not be shown in the result.- $excludefilter
array
Array of filter to exclude.- $naturalSort
boolean
False for asort, true for natsort.
Response
array
Files in the given folder.
folders
Helper wrapper method for folders
folders(string $path, string $filter = '.', mixed $recurse = false, boolean $full = false, array $exclude = array('.svn', 'CVS', '.DS_Store', '__MACOSX'), array $excludefilter = array('^\..*')) : array
see | \Joomla\CMS\Filesystem\Folder::folders() |
---|---|
since |
3.4 |
deprecated |
4.0 Use \Joomla\CMS\Filesystem\Folder instead |
Arguments
- $path
string
The path of the folder to read.- $filter
string
A filter for folder names.- $recurse
mixed
True to recursively search into sub-folders, or an integer to specify the maximum depth.- $full
boolean
True to return the full path to the folders.- $exclude
array
Array with names of folders which should not be shown in the result.- $excludefilter
array
Array with regular expressions matching folders which should not be shown in the result.
Response
array
Folders in the given folder.
listFolderTree
Helper wrapper method for listFolderTree
listFolderTree(string $path, string $filter, integer $maxLevel = 3, integer $level, integer $parent) : array
see | \Joomla\CMS\Filesystem\Folder::listFolderTree() |
---|---|
since |
3.4 |
deprecated |
4.0 Use \Joomla\CMS\Filesystem\Folder instead |
Arguments
- $path
string
The path of the folder to read.- $filter
string
A filter for folder names.- $maxLevel
integer
The maximum number of levels to recursively read, defaults to three.- $level
integer
The current level, optional.- $parent
integer
Unique identifier of the parent folder, if any.
Response
array
Folders in the given folder.
makeSafe
Helper wrapper method for makeSafe
makeSafe(string $path) : string
see | \Joomla\CMS\Filesystem\Folder::makeSafe() |
---|---|
since |
3.4 |
deprecated |
4.0 Use \Joomla\CMS\Filesystem\Folder instead |
Arguments
- $path
string
The full path to sanitise.
Response
string
The sanitised string
move
Helper wrapper method for move
move(string $src, string $dest, string $path = '', boolean $useStreams = false) : mixed
see | \Joomla\CMS\Filesystem\Folder::move() |
---|---|
since |
3.4 |
deprecated |
4.0 Use \Joomla\CMS\Filesystem\Folder instead |
Arguments
- $src
string
The path to the source folder.- $dest
string
The path to the destination folder.- $path
string
An optional base path to prefix to the file names.- $useStreams
boolean
Optionally use streams.
Response
mixed
Error message on false or boolean true on success.