Folder
A Folder handling class
| since |
1.0 |
|---|---|
| package |
Joomla Framework |
Methods
_items
Function to read the files/folders in a folder.
_items(string path, string filter, mixed recurse, bool full, array exclude, string excludeFilterString, bool findfiles) : array
| since |
1.0 |
|---|
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
boolTrue to return the full path to the file.- exclude
arrayArray with names of files which should not be shown in the result.- excludeFilterString
stringRegexp of files to exclude- findfiles
boolTrue to read the files, false to read the folders
Response
arrayFiles.
copy
Copy a folder.
copy(string src, string dest, string path = '', bool force = false, bool useStreams = false) : bool
| since |
1.0 |
|---|---|
| throws |
|
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
boolForce copy.- useStreams
boolOptionally force folder/file overwrites.
Response
boolTrue on success.
create
Create a folder -- and all necessary parent folders.
create(string path = '', int mode = 0755) : bool
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- path
stringA path to create from the base path.- mode
intDirectory permissions to set for folders created. 0755 by default.
Response
boolTrue if successful.
delete
Delete a folder.
delete(string path) : bool
| since |
1.0 |
|---|---|
| throws |
|
Arguments
- path
stringThe path to the folder to delete.
Response
boolTrue on success.
files
Utility function to read the files in a folder.
files(string path, string filter = '.', mixed recurse = false, bool full = false, array exclude = ['.svn', 'CVS', '.DS_Store', '__MACOSX'], array excludeFilter = ['^\..*', '.*~']) : array
| since |
1.0 |
|---|---|
| throws |
|
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
boolTrue 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
Response
arrayFiles in the given folder.
folders
Utility function to read the folders in a folder.
folders(string path, string filter = '.', mixed recurse = false, bool full = false, array exclude = ['.svn', 'CVS', '.DS_Store', '__MACOSX'], array excludeFilter = ['^\..*']) : array
| since |
1.0 |
|---|---|
| throws |
|
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
boolTrue 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, int maxLevel = 3, int level, int parent) : array
| since |
1.0 |
|---|
Arguments
- path
stringThe path of the folder to read.- filter
stringA filter for folder names.- maxLevel
intThe maximum number of levels to recursively read, defaults to three.- level
intThe current level, optional.- parent
intUnique 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 |
1.0 |
|---|
Arguments
- path
stringThe full path to sanitise.
Response
stringThe sanitised string.
move
Moves a folder.
move(string src, string dest, string path = '', bool useStreams = false) : string|bool
| since |
1.0 |
|---|
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.- useStreams
boolOptionally use streams.
Response
string|boolError message on false or boolean true on success.