1. class
  2. Joomla
  3. CMS
  4. Filesystem
  5. Folder

Folder

class Folder

A Folder handling class

Methods

static  boolean
copy( string $src, string $dest, string $path = '', boolean $force = false, boolean $use_streams = false)

Copy a folder.

static  boolean
create( string $path = '', integer $mode = 493)

Create a folder -- and all necessary parent folders.

static  boolean
delete( string $path)

Delete a folder.

static  mixed
move( string $src, string $dest, string $path = '', boolean $use_streams = false)

Moves a folder.

static  boolean
exists( string $path)

Wrapper for the standard file_exists function

static  array
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)

Utility function to read the files in a folder.

static  array
folders( string $path, string $filter = '.', mixed $recurse = false, boolean $full = false, array $exclude = array('.svn', 'CVS', '.DS_Store', '__MACOSX'), array $excludefilter = array('^\\..*'))

Utility function to read the folders in a folder.

static  array
listFolderTree( string $path, string $filter, integer $maxLevel = 3, integer $level, integer $parent)

Lists folder in format suitable for tree display.

static  string
makeSafe( string $path)

Makes path name safe to use.

Details

static boolean copy( string $src, string $dest, string $path = '', boolean $force = false, boolean $use_streams = false)

Copy a folder.

Parameters

string $src The path to the source folder.
string $dest The path to the destination folder.
string $path An optional base path to prefix to the file names.
boolean $force Force copy.
boolean $use_streams Optionally force folder/file overwrites.

Return Value

boolean True on success.

Exceptions

RuntimeException

static boolean create( string $path = '', integer $mode = 493)

Create a folder -- and all necessary parent folders.

Parameters

string $path A path to create from the base path.
integer $mode Directory permissions to set for folders created. 0755 by default.

Return Value

boolean True if successful.

static boolean delete( string $path)

Delete a folder.

Parameters

string $path The path to the folder to delete.

Return Value

boolean True on success.

static mixed move( string $src, string $dest, string $path = '', boolean $use_streams = false)

Moves a folder.

Parameters

string $src The path to the source folder.
string $dest The path to the destination folder.
string $path An optional base path to prefix to the file names.
boolean $use_streams Optionally use streams.

Return Value

mixed Error message on false or boolean true on success.

static boolean exists( string $path)

Wrapper for the standard file_exists function

Parameters

string $path Folder name relative to installation dir

Return Value

boolean True if path is a folder

static array 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)

Utility function to read the files in a folder.

Parameters

string $path The path of the folder to read.
string $filter A filter for file names.
mixed $recurse True to recursively search into sub-folders, or an integer to specify the maximum depth.
boolean $full True to return the full path to the file.
array $exclude Array with names of files which should not be shown in the result.
array $excludefilter Array of filter to exclude
boolean $naturalSort False for asort, true for natsort

Return Value

array Files in the given folder.

static array folders( string $path, string $filter = '.', mixed $recurse = false, boolean $full = false, array $exclude = array('.svn', 'CVS', '.DS_Store', '__MACOSX'), array $excludefilter = array('^\\..*'))

Utility function to read the folders in a folder.

Parameters

string $path The path of the folder to read.
string $filter A filter for folder names.
mixed $recurse True to recursively search into sub-folders, or an integer to specify the maximum depth.
boolean $full True to return the full path to the folders.
array $exclude Array with names of folders which should not be shown in the result.
array $excludefilter Array with regular expressions matching folders which should not be shown in the result.

Return Value

array Folders in the given folder.

static array listFolderTree( string $path, string $filter, integer $maxLevel = 3, integer $level, integer $parent)

Lists folder in format suitable for tree display.

Parameters

string $path The path of the folder to read.
string $filter A filter for folder names.
integer $maxLevel The maximum number of levels to recursively read, defaults to three.
integer $level The current level, optional.
integer $parent Unique identifier of the parent folder, if any.

Return Value

array Folders in the given folder.

static string makeSafe( string $path)

Makes path name safe to use.

Parameters

string $path The full path to sanitise.

Return Value

string The sanitised string.