Référence de la classe XoopsFolderHandler

Fonctions membres publiques
	__construct ($path=false, $create=true, $mode=false)
	pwd ()
	cd ($path)
	read ($sort=true, $exceptions=false)
	find ($regexp_pattern='.*', $sort=false)
	findRecursive ($pattern='.*', $sort=false)
	_findRecursive ($pattern, $sort=false)
	inXoopsPath ($path='')
	inPath ($path='', $reverse=false)
	chmod ($path, $mode=false, $recursive=true, $exceptions=array())
	tree ($path, $hidden=true, $type=null)
	_tree ($path, $hidden)
	create ($pathname, $mode=false)
	dirsize ()
	delete ($path)
	copy ($options=array())
	move ($options)
	messages ()
	errors ()
	realpath ($path)

Fonctions membres publiques statiques
	isWindowsPath ($path)
	isAbsolute ($path)
	normalizePath ($path)
	correctSlashFor ($path)
	slashTerm ($path)
	addPathElement ($path, $element)
	isSlashTerm ($path)

Champs de données
	$path
	$sort = false
	$mode = '0755'
	$messages = array()
	$errors = false
	$directories
	$files

Documentation des constructeurs et destructeur

__construct()

__construct	(		$path = false,
			$create = true,
			$mode = false
	)

Constructor.

Paramètres

bool | string	$path	Path to folder
boolean	$create	Create folder if not found
mixed	$mode	Mode (CHMOD) to apply to created folder, false to ignore

Voici le graphe d'appel pour cette fonction :

Documentation des fonctions membres

_findRecursive()

_findRecursive	(		$pattern,
			$sort = false
	)

Private helper function for findRecursive.

Paramètres

string	$pattern	Pattern to match against
bool	$sort

Renvoie

array Files matching pattern @access private

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

_tree()

_tree	(		$path,
			$hidden
	)

Private method to list directories and files in each directory

Paramètres

string	$path
	$hidden

Voici le graphe des appelants de cette fonction :

addPathElement()

addPathElement (   $path,   $element  )

static

Returns $path with $element added, with correct slash in-between.

Paramètres

string	$path	Path
string	$element	Element to and at end of path

Renvoie

string Combined path @access public

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

cd()

cd

(

$path

)

Change directory to $desired_path.

Paramètres

string

$path

Path to the directory to change to

Renvoie

string The new path. Returns false on failure @access public

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

chmod()

chmod	(		$path,
			$mode = false,
			$recursive = true,
			$exceptions = array()
	)

Change the mode on a directory structure recursively.

Paramètres

string	$path	The path to chmod
bool | int	$mode	octal value 0755
boolean	$recursive	chmod recursively
array	$exceptions	array of files, directories to skip

Renvoie

boolean Returns TRUE on success, FALSE on failure @access public

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

copy()

copy

(

$options = array()

)

Recursive directory copy.

Paramètres

array | string

$options

(to, from, chmod, skip)

Renvoie

bool @access public

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

correctSlashFor()

correctSlashFor (   $path )

static

Returns a correct set of slashes for given $path. (\ for Windows paths and / for other paths.)

Paramètres

string

$path

Path to check

Renvoie

string Set of slashes ("\\" or "/") @access public

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

create()

create	(		$pathname,
			$mode = false
	)

Create a directory structure recursively.

Paramètres

string	$pathname	The directory structure to create
bool | int	$mode	octal value 0755

Renvoie

boolean Returns TRUE on success, FALSE on failure @access public

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

delete()

delete

(

$path

)

Recursively Remove directories if system allow.

Paramètres

string

$path

Path of directory to delete

Renvoie

boolean Success @access public

Voici le graphe d'appel pour cette fonction :

dirsize()

dirsize

(

)

Returns the size in bytes of this Folder.

Renvoie

int $size @access public

Voici le graphe d'appel pour cette fonction :

errors()

errors

(

)

get error from latest method

Renvoie

array @access public

Voici le graphe des appelants de cette fonction :

find()

find	(		$regexp_pattern = '.*',
			$sort = false
	)

Returns an array of all matching files in current directory.

Paramètres

string	$regexp_pattern	Preg_match pattern (Defaults to: .*)
bool	$sort

Renvoie

array Files that match given pattern @access public

Voici le graphe d'appel pour cette fonction :

findRecursive()

findRecursive	(		$pattern = '.*',
			$sort = false
	)

Returns an array of all matching files in and below current directory.

Paramètres

string	$pattern	Preg_match pattern (Defaults to: .*)
bool	$sort

Renvoie

array Files matching $pattern @access public

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

inPath()

inPath	(		$path = '',
			$reverse = false
	)

Returns true if the File is in given path.

Paramètres

string	$path
bool	$reverse

Renvoie

bool @access public

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

inXoopsPath()

inXoopsPath

(

$path = ''

)

Returns true if the File is in a given XoopsPath.

Paramètres

string

$path

Renvoie

bool @access public

Voici le graphe d'appel pour cette fonction :

isAbsolute()

isAbsolute (   $path )

static

Returns true if given $path is an absolute path.

Paramètres

string

$path

Path to check

Renvoie

bool @access public

Voici le graphe des appelants de cette fonction :

isSlashTerm()

isSlashTerm (   $path )

static

Returns true if given $path ends in a slash (i.e. is slash-terminated).

Paramètres

string

$path

Path to check

Renvoie

boolean true if path ends with slash, false otherwise @access public

Voici le graphe des appelants de cette fonction :

isWindowsPath()

isWindowsPath (   $path )

static

Returns true if given $path is a Windows path.

Paramètres

string

$path

Path to check

Renvoie

boolean true if windows path, false otherwise @access public

Voici le graphe des appelants de cette fonction :

messages()

messages

(

)

get messages from latest method

Renvoie

array @access public

Voici le graphe des appelants de cette fonction :

move()

move

(

$options

)

Recursive directory move.

Paramètres

array | string

$options

(to, from, chmod, skip)

Renvoie

boolean Success @access public

Voici le graphe d'appel pour cette fonction :

normalizePath()

normalizePath (   $path )

static

Returns a correct set of slashes for given $path. (\ for Windows paths and / for other paths.)

Paramètres

string

$path

Path to check

Renvoie

string Set of slashes ("\\" or "/") @access public

Voici le graphe d'appel pour cette fonction :

pwd()

pwd

(

)

Return current path.

Renvoie

string Current path @access public

Voici le graphe des appelants de cette fonction :

read()

read	(		$sort = true,
			$exceptions = false
	)

Returns an array of the contents of the current directory, or false on failure. The returned array holds two arrays: one of dirs and one of files.

Paramètres

boolean	$sort
mixed	$exceptions	either an array or boolean true will no grab dot files

Renvoie

mixed Contents of current directory as an array, false on failure @access public

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

realpath()

realpath

(

$path

)

Get the real path (taking ".." and such into account)

Paramètres

string

$path

Path to resolve

Renvoie

string The resolved path

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

slashTerm()

slashTerm (   $path )

static

Returns $path with added terminating slash (corrected for Windows or other OS).

Paramètres

string

$path

Path to check

Renvoie

string Path with ending slash @access public

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

tree()

tree	(		$path,
			$hidden = true,
			$type = null
	)

Returns an array of nested directories and files in each directory

Paramètres

string	$path	the directory path to build the tree from
boolean	$hidden	return hidden files and directories
string	$type	either file or dir. null returns both files and directories

Renvoie

mixed array of nested directories and files in each directory @access public

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

Documentation des champs

$directories

$directories

$errors

$errors = false

$files

$files

$messages

$messages = array()

$mode

$mode = '0755'

$path

$path

$sort

$sort = false

---

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

• XoopsCore25-2.5.11-Beta1/htdocs/class/file/folder.php