JFolder
A Folder handling class
| package |
Joomla.Platform |
|---|---|
| subpackage |
FileSystem |
| since |
11.1 |
Methods
_items
Function to read the files/folders in a folder.
_items(string $path, string $filter, mixed $recurse, boolean $full, array $exclude, string $excludefilter_string, boolean $findfiles) : array
| since |
11.1 |
|---|
Arguments
- $path
stringThe path of the folder to read.- $filter
stringA filter for file names.- $recurse
mixedTrue to recursively search into sub-folders, or an integer to specify the maximum depth.- $full
booleanTrue to return the full path to the file.- $exclude
arrayArray with names of files which should not be shown in the result.- $excludefilter_string
stringRegexp of files to exclude- $findfiles
booleanTrue to read the files, false to read the folders
Response
arrayFiles.
copy
Copy a folder.
copy(string $src, string $dest, string $path = '', string $force = false, boolean $use_streams = false) : mixed
| since |
11.1 |
|---|
Arguments
- $src
stringThe path to the source folder.- $dest
stringThe path to the destination folder.- $path
stringAn optional base path to prefix to the file names.- $force
stringForce copy.- $use_streams
booleanOptionally force folder/file overwrites.
Response
mixedJError object on failure or boolean True on success.
create
Create a folder -- and all necessary parent folders.
create(string $path = '', integer $mode = 493) : boolean
| since |
11.1 |
|---|
Arguments
- $path
stringA path to create from the base path.- $mode
integerDirectory permissions to set for folders created. 0755 by default.
Response
booleanTrue if successful.
delete
Delete a folder.
delete(string $path) : boolean
| since |
11.1 |
|---|
Arguments
- $path
stringThe path to the folder to delete.
Response
booleanTrue on success.
exists
Wrapper for the standard file_exists function
exists(string $path) : boolean
| since |
11.1 |
|---|
Arguments
- $path
stringFolder name relative to installation dir
Response
booleanTrue if path is a folder
files
Utility function to read the files in a folder.
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
| since |
11.1 |
|---|
Arguments
- $path
stringThe path of the folder to read.- $filter
stringA filter for file names.- $recurse
mixedTrue to recursively search into sub-folders, or an integer to specify the maximum depth.- $full
booleanTrue to return the full path to the file.- $exclude
arrayArray with names of files which should not be shown in the result.- $excludefilter
arrayArray of filter to exclude- $naturalSort
booleanFalse for asort, true for natsort
Response
arrayFiles in the given folder.
folders
Utility function to read the folders in a folder.
folders(string $path, string $filter = '.', mixed $recurse = false, boolean $full = false, array $exclude = array('.svn', 'CVS', '.DS_Store', '__MACOSX'), array $excludefilter = array('^\..*')) : array
| since |
11.1 |
|---|
Arguments
- $path
stringThe path of the folder to read.- $filter
stringA filter for folder names.- $recurse
mixedTrue to recursively search into sub-folders, or an integer to specify the maximum depth.- $full
booleanTrue to return the full path to the folders.- $exclude
arrayArray with names of folders which should not be shown in the result.- $excludefilter
arrayArray with regular expressions matching folders which should not be shown in the result.
Response
arrayFolders in the given folder.
listFolderTree
Lists folder in format suitable for tree display.
listFolderTree(string $path, string $filter, integer $maxLevel = 3, integer $level, integer $parent) : array
| since |
11.1 |
|---|
Arguments
- $path
stringThe path of the folder to read.- $filter
stringA filter for folder names.- $maxLevel
integerThe maximum number of levels to recursively read, defaults to three.- $level
integerThe current level, optional.- $parent
integerUnique identifier of the parent folder, if any.
Response
arrayFolders in the given folder.
makeSafe
Makes path name safe to use.
makeSafe(string $path) : string
| since |
11.1 |
|---|
Arguments
- $path
stringThe full path to sanitise.
Response
stringThe sanitised string.
move
Moves a folder.
move(string $src, string $dest, string $path = '', boolean $use_streams = false) : mixed
| since |
11.1 |
|---|
Arguments
- $src
stringThe path to the source folder.- $dest
stringThe path to the destination folder.- $path
stringAn optional base path to prefix to the file names.- $use_streams
booleanOptionally use streams.
Response
mixedError message on false or boolean true on success.