Référence de la classe Path

Fonctions membres publiques statiques
static	canChmod ($path)
static	setPermissions ($path, $filemode='0644', $foldermode='0755')
static	getPermissions ($path)
static	check ($path)
static	clean ($path, $ds=\DIRECTORY_SEPARATOR)
static	isOwner ($path)
static	find ($paths, $file)
static	resolve ($path)
static	removeRoot ($message, $rootDirectory=null)

Fonctions membres privées statiques
static	makePattern ($dir)

Description détaillée

A Path handling class

Depuis

1.0

Documentation des fonctions membres

canChmod()

static canChmod (   $path )

static

Checks if a path's permissions can be changed.

Paramètres

string

$path

Path to check.

Renvoie

boolean True if path can have mode changed.

Depuis

1.0

Références $path.

Référencé par File\delete().

check()

static check (   $path )

static

Checks for snooping outside of the file system root.

Paramètres

string

$path

A file system path to check.

Renvoie

string A cleaned version of the path or exit on error.

Depuis

1.0

Exceptions

FilesystemException

Références $path, et JPATH_ROOT.

clean()

static clean (   $path,   $ds = \DIRECTORY_SEPARATOR  )

static

Function to strip additional / or \ in a path name.

Paramètres

string	$path	The path to clean.
string	$ds	Directory separator (optional).

Renvoie

string The cleaned path.

Depuis

1.0

Exceptions

Références $path, elseif, et JPATH_ROOT.

Référencé par Folder\_items(), Folder\copy(), File\copy(), Folder\create(), File\delete(), Folder\delete(), Tar\extract(), Zip\extractCustom(), Folder\files(), Folder\folders(), Tar\isBelow(), Zip\isBelow(), Folder\listFolderTree(), File\move(), Folder\move(), File\upload(), et File\write().

find()

static find (   $paths,   $file  )

static

Searches the directory paths for a given file.

Paramètres

mixed	$paths	A path string or array of path strings to search in
string	$file	The file name to look for.

Renvoie

string|boolean The full path and file name for the target file, or boolean false if the file is not found in any of the paths.

Depuis

1.0

Références $file, et $path.

getPermissions()

static getPermissions (   $path )

static

Get the permissions of the file/folder at a give path.

Paramètres

string

$path

The path of a file/folder.

Renvoie

string Filesystem permissions.

Depuis

1.0

Références $i, $mode, et $path.

isOwner()

static isOwner (   $path )

static

Method to determine if script owns the path.

Paramètres

string

$path

Path to check ownership.

Renvoie

boolean True if the php script owns the path passed.

Depuis

1.0

Références $path, $return, $tmp, File\delete(), JPATH_ROOT, et File\write().

makePattern()

static makePattern (   $dir )

staticprivate

Turn directory separators into match classes

Paramètres

string

$dir

A directory name

Renvoie

string

Depuis

1.6.2

removeRoot()

static removeRoot (   $message,   $rootDirectory = null  )

static

Remove all references to root directory path and the system tmp path from a message

Paramètres

string	$message	The message to be cleaned
string	$rootDirectory	Optional root directory, defaults to JPATH_ROOT

Renvoie

string

Depuis

1.6.2

Références $message, et JPATH_ROOT.

Référencé par FilesystemException\__construct(), Patcher\applyHunk(), File\copy(), Folder\delete(), Folder\files(), et Folder\folders().

resolve()

static resolve (   $path )

static

Resolves /./, /../ and multiple / in a string and returns the resulting absolute path, inspired by Flysystem Removes trailing slashes

Paramètres

string

$path

A path to resolve

Renvoie

string The resolved path

Depuis

1.6.0

Références $parts, $path, et DIRECTORY_SEPARATOR.

Référencé par Tar\extract(), Tar\isBelow(), et Zip\isBelow().

setPermissions()

static setPermissions (   $path,   $filemode = '0644',   $foldermode = '0755'  )

static

Chmods files and directories recursively to given permissions.

Paramètres

string	$path	Root path to begin changing mode [without trailing slash].
string	$filemode	Octal representation of the value to change file mode to [null = no change].
string	$foldermode	Octal representation of the value to change folder mode to [null = no change].

Renvoie

boolean True if successful [one fail means the whole operation failed].

Depuis

1.0

Références $file, et $path.

Référencé par File\upload().

---

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

• vendor/joomla/filesystem/src/Path.php