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.7.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.7.0

Références $path.

Référencé par PathWrapper\canChmod().

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.7.0

Exceptions

Exception

Références $path, et JPATH_ROOT.

Référencé par PathWrapper\check(), et FilePathRule\test().

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.7.0

Exceptions

UnexpectedValueException

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

Référencé par File\append(), et PathWrapper\clean().

find()

static find (   $paths,   $file  )

static

Searches the directory paths for a given file.

Paramètres

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

Renvoie

mixed 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.7.0

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

Référencé par PathWrapper\find().

getPermissions()

static getPermissions (   $path )

static

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

Paramètres

string

$path

The path of a file/folder.

Renvoie

string Filesystem permissions.

Depuis

1.7.0

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

Référencé par PathWrapper\getPermissions().

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.7.0

Références $path, $return, $tmp, Crypt\genRandomBytes(), et JPATH_SITE.

Référencé par PathWrapper\isOwner().

makePattern()

static makePattern (   $dir )

staticprivate

Turn directory separators into match classes

Paramètres

string

$dir

A directory name

Renvoie

string

Depuis

3.10.7

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

3.10.7

Références $message, et JPATH_ROOT.

Référencé par LogEntry\__construct(), Patcher\applyHunk(), et Folder\copy().

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

3.9.25

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

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.7.0

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

Référencé par PathWrapper\setPermissions().

---

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

• src/Filesystem/Path.php