Référence de la classe FolderWrapper

Fonctions membres publiques
	copy ($src, $dest, $path='', $force=false, $useStreams=false)
	create ($path='', $mode=493)
	delete ($path)
	move ($src, $dest, $path='', $useStreams=false)
	exists ($path)
	files ($path, $filter='.', $recurse=false, $full=false, $exclude=array('.svn', 'CVS', '.DS_Store', '__MACOSX'), $excludefilter=array('^\..*', '.*~'), $naturalSort=false)
	folders ($path, $filter='.', $recurse=false, $full=false, $exclude=array('.svn', 'CVS', '.DS_Store', '__MACOSX'), $excludefilter=array('^\..*'))
	listFolderTree ($path, $filter, $maxLevel=3, $level=0, $parent=0)
	makeSafe ($path)

Description détaillée

Wrapper class for Folder

Depuis

3.4

Obsolète:

4.0 Use instead

Documentation des fonctions membres

copy()

copy	(		$src,
			$dest,
			$path = '',
			$force = false,
			$useStreams = false
	)

Helper wrapper method for copy

Paramètres

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	$useStreams	Optionally force folder/file overwrites.

Renvoie

boolean True on success.

Voir également

Folder::copy()

Depuis

3.4

Exceptions

RuntimeException

Obsolète:

4.0 Use instead

Références $path, et Folder\copy().

create()

create	(		$path = '',
			$mode = 493
	)

Helper wrapper method for create

Paramètres

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

Renvoie

boolean True if successful.

Voir également

Folder::create()

Depuis

3.4

Obsolète:

4.0 Use instead

Références $mode, $path, et Folder\create().

Référencé par File\copy(), et File\upload().

delete()

delete

(

$path

)

Helper wrapper method for delete

Paramètres

string

$path

The path to the folder to delete.

Renvoie

boolean True on success.

Voir également

Folder::delete()

Depuis

3.4

Exceptions

UnexpectedValueException

Obsolète:

4.0 Use instead

Références $path, et Folder\delete().

exists()

exists

(

$path

)

Helper wrapper method for exists

Paramètres

string

$path

Folder name relative to installation dir.

Renvoie

boolean True if path is a folder.

Voir également

Folder::exists()

Depuis

3.4

Obsolète:

4.0 Use instead

Références $path, et Folder\exists().

files()

files	(		$path,
			$filter = '.',
			$recurse = false,
			$full = false,
			$exclude = array('.svn', 'CVS', '.DS_Store', '__MACOSX'),
			$excludefilter = array('^\..*', '.*~'),
			$naturalSort = false
	)

Helper wrapper method for files

Paramètres

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.

Renvoie

array Files in the given folder.

Voir également

Folder::files()

Depuis

3.4

Obsolète:

4.0 Use instead

Références $filter, $path, et Folder\files().

folders()

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

Helper wrapper method for folders

Paramètres

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.

Renvoie

array Folders in the given folder.

Voir également

Folder::folders()

Depuis

3.4

Obsolète:

4.0 Use instead

Références $filter, $path, et Folder\folders().

listFolderTree()

listFolderTree	(		$path,
			$filter,
			$maxLevel = 3,
			$level = 0,
			$parent = 0
	)

Helper wrapper method for listFolderTree

Paramètres

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.

Renvoie

array Folders in the given folder.

Voir également

Folder::listFolderTree()

Depuis

3.4

Obsolète:

4.0 Use instead

Références $filter, $path, et Folder\listFolderTree().

makeSafe()

makeSafe

(

$path

)

Helper wrapper method for makeSafe

Paramètres

string

$path

The full path to sanitise.

Renvoie

string The sanitised string

Voir également

Folder::makeSafe()

Depuis

3.4

Obsolète:

4.0 Use instead

Références $path, et Folder\makeSafe().

move()

move	(		$src,
			$dest,
			$path = '',
			$useStreams = false
	)

Helper wrapper method for move

Paramètres

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	$useStreams	Optionally use streams.

Renvoie

mixed Error message on false or boolean true on success.

Voir également

Folder::move()

Depuis

3.4

Obsolète:

4.0 Use instead

Références $path, et Folder\move().

---

La documentation de cette classe a été générée à partir du fichier suivant :

• FolderWrapper.php