API17:JPath
From Joomla! Documentation
(Difference between revisions)
(Layout updates) |
(Updated to r1448:247ba8d88526) |
||
| Line 1: | Line 1: | ||
__NOTOC__ | __NOTOC__ | ||
| + | =={{JVer|11.1}} JPath== | ||
| + | ===Description=== | ||
| + | {{Description:JPath}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[Description:JPath|Edit Descripton]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[Description:JPath|Edit Descripton]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
| − | |||
===Methods=== | ===Methods=== | ||
{| class="wikitable sortable" | {| class="wikitable sortable" | ||
|- | |- | ||
| + | !Visibility | ||
!Method name | !Method name | ||
!Description | !Description | ||
|- | |- | ||
| + | |public static | ||
|[[JPath::canChmod/11.1|canChmod]] | |[[JPath::canChmod/11.1|canChmod]] | ||
|Checks if a path's permissions can be changed. | |Checks if a path's permissions can be changed. | ||
|- | |- | ||
| + | |public static | ||
|[[JPath::check/11.1|check]] | |[[JPath::check/11.1|check]] | ||
|Checks for snooping outside of the file system root. | |Checks for snooping outside of the file system root. | ||
|- | |- | ||
| + | |public static | ||
|[[JPath::clean/11.1|clean]] | |[[JPath::clean/11.1|clean]] | ||
|Function to strip additional / or \ in a path name. | |Function to strip additional / or \ in a path name. | ||
|- | |- | ||
| + | |public static | ||
|[[JPath::find/11.1|find]] | |[[JPath::find/11.1|find]] | ||
|Searches the directory paths for a given file. | |Searches the directory paths for a given file. | ||
|- | |- | ||
| + | |public static | ||
|[[JPath::getPermissions/11.1|getPermissions]] | |[[JPath::getPermissions/11.1|getPermissions]] | ||
|Get the permissions of the file/folder at a give path. | |Get the permissions of the file/folder at a give path. | ||
|- | |- | ||
| + | |public static | ||
|[[JPath::isOwner/11.1|isOwner]] | |[[JPath::isOwner/11.1|isOwner]] | ||
|Method to determine if script owns the path. | |Method to determine if script owns the path. | ||
|- | |- | ||
| + | |public static | ||
|[[JPath::setPermissions/11.1|setPermissions]] | |[[JPath::setPermissions/11.1|setPermissions]] | ||
|Chmods files and directories recursivly to given permissions. | |Chmods files and directories recursivly to given permissions. | ||
|- | |- | ||
|} | |} | ||
| + | * '''Defined in''' libraries/joomla/filesystem/path.php | ||
===Importing=== | ===Importing=== | ||
<source lang="php">jimport( 'joomla.filesystem.path' );</source> | <source lang="php">jimport( 'joomla.filesystem.path' );</source> | ||
===See also=== | ===See also=== | ||
| − | * JPath source code | + | * {{JVer|11.1}} '''JPath source code''' on [[jplatform:filesystem/path.php|BitBucket]] |
| − | * [[JPath|Other versions of | + | * {{JVer|11.1}} Subpackage [[Subpackage Filesystem/11.1|Filesystem]] |
| + | * [[JPath|Other versions of JPath]] | ||
{{SeeAlso:JPath}} | {{SeeAlso:JPath}} | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[</nowiki>[[SeeAlso:JPath|Edit See Also]]<nowiki>]</nowiki> | <nowiki>[</nowiki>[[SeeAlso:JPath|Edit See Also]]<nowiki>]</nowiki> | ||
</span> | </span> | ||
| − | === | + | ===User contributed notes=== |
<CodeExamplesForm /> | <CodeExamplesForm /> | ||
<dpl> | <dpl> | ||
| Line 56: | Line 61: | ||
category=ClassExample | category=ClassExample | ||
include=* | include=* | ||
| + | namespace=CodeExample | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
<noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JPath]]</noinclude> | <noinclude>[[Category:Platform]][[Category:Platform 11.1]][[Category:JPath]]</noinclude> | ||
Revision as of 18:07, 27 April 2011
JPath
Description
Description:JPath [Edit Descripton]
Methods
| Visibility | Method name | Description |
|---|---|---|
| public static | canChmod | Checks if a path's permissions can be changed. |
| public static | check | Checks for snooping outside of the file system root. |
| public static | clean | Function to strip additional / or \ in a path name. |
| public static | find | Searches the directory paths for a given file. |
| public static | getPermissions | Get the permissions of the file/folder at a give path. |
| public static | isOwner | Method to determine if script owns the path. |
| public static | setPermissions | Chmods files and directories recursivly to given permissions. |
- Defined in libraries/joomla/filesystem/path.php
Importing
jimport( 'joomla.filesystem.path' );
See also
- JPath source code on BitBucket
- Subpackage Filesystem
- Other versions of JPath
User contributed notes
<CodeExamplesForm />
