Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
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, $basePath='')
 
static clean ($path, $ds=\DIRECTORY_SEPARATOR)
 
static isOwner ($path)
 
static find ($paths, $file)
 
static resolve ($path)
 
static removeRoot ($message, $rootDirectory=null)
 

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$pathPath 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,
  $basePath = '' 
)
static

Checks for snooping outside of the file system root.

Paramètres
string$pathA file system path to check.
string$basePathThe base path of the system
Renvoie
string A cleaned version of the path or exit on error.
Depuis
1.0
Exceptions
FilesystemException

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

Référencé par Checkfiles\checkImages().

◆ clean()

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

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

Paramètres
string$pathThe path to clean.
string$dsDirectory separator (optional).
Renvoie
string The cleaned path.
Depuis
1.0
Exceptions

Références $path, et Laminas\Diactoros\$stream.

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(), Requests\makeGetRequest(), 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$pathsA path string or array of path strings to search in
string$fileThe 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 $path.

◆ getPermissions()

static getPermissions (   $path)
static

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

Paramètres
string$pathThe 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$pathPath to check ownership.
Renvoie
boolean True if the php script owns the path passed.
Depuis
1.0

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

Référencé par SiteStatus\writeConfigFile().

◆ 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$messageThe message to be cleaned
string$rootDirectoryOptional root directory, defaults to JPATH_ROOT
Renvoie
string
Depuis
2.0.1

Références $dir, $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$pathA path to resolve
Renvoie
string The resolved path
Depuis
1.6.0

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

Référencé par 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$pathRoot path to begin changing mode [without trailing slash].
string$filemodeOctal representation of the value to change file mode to [null = no change].
string$foldermodeOctal 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 $path.

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


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