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
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
bool
True to return the full path to the file.- exclude
array
Array with names of files which should not be shown in the result.- excludeFilterString
string
Regexp of files to exclude- findfiles
bool
True to read the files, false to read the folders
Response
array
Files.
copy
Copy a folder.
copy(string src, string dest, string path = '', bool force = false, bool useStreams = false) : bool
since |
1.0 |
---|---|
throws |
|
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
bool
Force copy.- useStreams
bool
Optionally force folder/file overwrites.
Response
bool
True on success.
create
Create a folder -- and all necessary parent folders.
create(string path = '', int mode = 0755) : bool
since |
1.0 |
---|---|
throws |
|
Arguments
- path
string
A path to create from the base path.- mode
int
Directory permissions to set for folders created. 0755 by default.
Response
bool
True if successful.
delete
Delete a folder.
delete(string path) : bool
since |
1.0 |
---|---|
throws |
|
Arguments
- path
string
The path to the folder to delete.
Response
bool
True 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
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
bool
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
Response
array
Files 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
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
bool
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
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
string
The path of the folder to read.- filter
string
A filter for folder names.- maxLevel
int
The maximum number of levels to recursively read, defaults to three.- level
int
The current level, optional.- parent
int
Unique identifier of the parent folder, if any.
Response
array
Folders in the given folder.
makeSafe
Makes path name safe to use.
makeSafe(string path) : string
since |
1.0 |
---|
Arguments
- path
string
The full path to sanitise.
Response
string
The sanitised string.
move
Moves a folder.
move(string src, string dest, string path = '', bool useStreams = false) : string|bool
since |
1.0 |
---|
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
bool
Optionally use streams.
Response
string|bool
Error message on false or boolean true on success.