PathWrapper
Wrapper class for Path
since |
3.4 |
---|---|
deprecated |
4.0 Use \Joomla\CMS\Filesystem\Path instead |
Methods
canChmod
Helper wrapper method for canChmod
canChmod(string $path) : boolean
see | \Joomla\CMS\Filesystem\Path::canChmod() |
---|---|
since |
3.4 |
deprecated |
4.0 Use \Joomla\CMS\Filesystem\Path instead |
Arguments
- $path
string
Path to check.
Response
boolean
True if path can have mode changed.
check
Helper wrapper method for check
check(string $path) : string
see | \Joomla\CMS\Filesystem\Path::check() |
---|---|
since |
3.4 |
throws |
|
deprecated |
4.0 Use \Joomla\CMS\Filesystem\Path instead |
Arguments
- $path
string
A file system path to check.
Response
string
A cleaned version of the path or exit on error.
clean
Helper wrapper method for clean
clean(string $path, string $ds = DIRECTORY_SEPARATOR) : string
see | \Joomla\CMS\Filesystem\Path::clean() |
---|---|
since |
3.4 |
throws |
|
deprecated |
4.0 Use \Joomla\CMS\Filesystem\Path instead |
Arguments
- $path
string
The path to clean.- $ds
string
Directory separator (optional).
Response
string
The cleaned path.
find
Helper wrapper method for find
find(mixed $paths, string $file) : mixed
see | \Joomla\CMS\Filesystem\Path::find() |
---|---|
since |
3.4 |
deprecated |
4.0 Use \Joomla\CMS\Filesystem\Path instead |
Arguments
- $paths
mixed
A path string or array of path strings to search in- $file
string
The file name to look for.
Response
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.
getPermissions
Helper wrapper method for getPermissions
getPermissions(string $path) : string
see | \Joomla\CMS\Filesystem\Path::getPermissions() |
---|---|
since |
3.4 |
deprecated |
4.0 Use \Joomla\CMS\Filesystem\Path instead |
Arguments
- $path
string
The path of a file/folder.
Response
string
Filesystem permissions.
isOwner
Helper wrapper method for isOwner
isOwner(string $path) : boolean
see | \Joomla\CMS\Filesystem\Path::isOwner() |
---|---|
since |
3.4 |
deprecated |
4.0 Use \Joomla\CMS\Filesystem\Path instead |
Arguments
- $path
string
Path to check ownership.
Response
boolean
True if the php script owns the path passed.
setPermissions
Helper wrapper method for setPermissions
setPermissions(string $path, string $filemode = '0644', string $foldermode = '0755') : boolean
see | \Joomla\CMS\Filesystem\Path::setPermissions() |
---|---|
since |
3.4 |
deprecated |
4.0 Use \Joomla\CMS\Filesystem\Path instead |
Arguments
- $path
string
Root path to begin changing mode [without trailing slash].- $filemode
string
Octal representation of the value to change file mode to [null = no change].- $foldermode
string
Octal representation of the value to change folder mode to [null = no change].
Response
boolean
True if successful [one fail means the whole operation failed].