PathWrapper
Wrapper class for Path
| package |
Joomla.Platform |
|---|---|
| subpackage |
Filesystem |
| 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
stringPath to check.
Response
booleanTrue 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
stringA file system path to check.
Response
stringA 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
stringThe path to clean.- $ds
stringDirectory separator (optional).
Response
stringThe 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
mixedA path string or array of path strings to search in- $file
stringThe file name to look for.
Response
mixedThe 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
stringThe path of a file/folder.
Response
stringFilesystem 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
stringPath to check ownership.
Response
booleanTrue 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
stringRoot path to begin changing mode [without trailing slash].- $filemode
stringOctal representation of the value to change file mode to [null = no change].- $foldermode
stringOctal representation of the value to change folder mode to [null = no change].
Response
booleanTrue if successful [one fail means the whole operation failed].