Actions

API17

Difference between revisions of "JPath::clean"

From Joomla! Documentation

(Bulk upload by Doxiki2)
 
(Updated to r1448:247ba8d88526)
(One intermediate revision by one user not shown)
Line 8: Line 8:
 
<nowiki>[</nowiki>[[Description:JPath::clean|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JPath::clean|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Since===
 
{{JVer|11.1 }}
 
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
public static JPath::clean ($path, $ds=DIRECTORY_SEPARATOR)
+
public static function clean (
 +
        $path
 +
        $ds=DIRECTORY_SEPARATOR
 +
)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 32: Line 32:
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''Returns''' string The cleaned path
string The cleaned path
+
* '''Defined''' on line 167 of libraries/joomla/filesystem/path.php
===Defined in===
+
* '''Since''' {{JVer|11.1 }}
libraries/joomla/filesystem/path.php
+
* '''Referenced by'''
===Referenced by===
+
** [[JArchiveZip::_extract/11.1|JArchiveZip::_extract]]
* [[JArchiveZip/_extract/11.1|JArchiveZip::_extract]]
+
** [[JElementModuleLayouts::_getOptions/11.1|JElementModuleLayouts::_getOptions]]
* [[JElementModuleLayouts/_getOptions/11.1|JElementModuleLayouts::_getOptions]]
+
** [[JElementComponentLayouts::_getOptions/11.1|JElementComponentLayouts::_getOptions]]
* [[JElementComponentLayouts/_getOptions/11.1|JElementComponentLayouts::_getOptions]]
+
** [[JHtml::addIncludePath/11.1|JHtml::addIncludePath]]
* [[JHtml/addIncludePath/11.1|JHtml::addIncludePath]]
+
** [[JCacheStorage::addIncludePath/11.1|JCacheStorage::addIncludePath]]
* [[JCacheStorage/addIncludePath/11.1|JCacheStorage::addIncludePath]]
+
** [[JCache::addIncludePath/11.1|JCache::addIncludePath]]
* [[JCache/addIncludePath/11.1|JCache::addIncludePath]]
+
** [[JModel::addIncludePath/11.1|JModel::addIncludePath]]
* [[JModel/addIncludePath/11.1|JModel::addIncludePath]]
+
** [[JCacheController::addIncludePath/11.1|JCacheController::addIncludePath]]
* [[JCacheController/addIncludePath/11.1|JCacheController::addIncludePath]]
+
** [[check/11.1|check]]
* [[check/11.1|check]]
+
** [[JInstallerHelper::cleanupInstall/11.1|JInstallerHelper::cleanupInstall]]
* [[JInstallerHelper/cleanupInstall/11.1|JInstallerHelper::cleanupInstall]]
+
** [[JFolder::copy/11.1|JFolder::copy]]
* [[JFolder/copy/11.1|JFolder::copy]]
+
** [[JFile::copy/11.1|JFile::copy]]
* [[JFile/copy/11.1|JFile::copy]]
+
** [[JInstaller::copyFiles/11.1|JInstaller::copyFiles]]
* [[JInstaller/copyFiles/11.1|JInstaller::copyFiles]]
+
** [[JFolder::create/11.1|JFolder::create]]
* [[JFolder/create/11.1|JFolder::create]]
+
** [[JFolder::delete/11.1|JFolder::delete]]
* [[JFolder/delete/11.1|JFolder::delete]]
+
** [[JFile::delete/11.1|JFile::delete]]
* [[JFile/delete/11.1|JFile::delete]]
+
** [[JInstallerComponent::discover_install/11.1|JInstallerComponent::discover_install]]
* [[JInstallerComponent/discover_install/11.1|JInstallerComponent::discover_install]]
+
** [[JFolder::exists/11.1|JFolder::exists]]
* [[JFolder/exists/11.1|JFolder::exists]]
+
** [[JFile::exists/11.1|JFile::exists]]
* [[JFile/exists/11.1|JFile::exists]]
+
** [[JArchiveTar::extract/11.1|JArchiveTar::extract]]
* [[JArchiveTar/extract/11.1|JArchiveTar::extract]]
+
** [[JArchive::extract/11.1|JArchive::extract]]
* [[JArchive/extract/11.1|JArchive::extract]]
+
** [[JFolder::files/11.1|JFolder::files]]
* [[JFolder/files/11.1|JFolder::files]]
+
** [[JFolder::folders/11.1|JFolder::folders]]
* [[JFolder/folders/11.1|JFolder::folders]]
+
** [[JFormFieldModuleLayout::getInput/11.1|JFormFieldModuleLayout::getInput]]
* [[JFormFieldModuleLayout/getInput/11.1|JFormFieldModuleLayout::getInput]]
+
** [[JFormFieldComponentLayout::getInput/11.1|JFormFieldComponentLayout::getInput]]
* [[JFormFieldComponentLayout/getInput/11.1|JFormFieldComponentLayout::getInput]]
+
** [[getPermissions/11.1|getPermissions]]
* [[getPermissions/11.1|getPermissions]]
+
** [[JInstallerComponent::install/11.1|JInstallerComponent::install]]
* [[JInstallerComponent/install/11.1|JInstallerComponent::install]]
+
** [[JInstallerFile::install/11.1|JInstallerFile::install]]
* [[JInstallerFile/install/11.1|JInstallerFile::install]]
+
** [[JFolder::listFolderTree/11.1|JFolder::listFolderTree]]
* [[JFolder/listFolderTree/11.1|JFolder::listFolderTree]]
+
** [[JFolder::move/11.1|JFolder::move]]
* [[JFolder/move/11.1|JFolder::move]]
+
** [[JFile::move/11.1|JFile::move]]
* [[JFile/move/11.1|JFile::move]]
+
** [[JInstaller::parseMedia/11.1|JInstaller::parseMedia]]
* [[JInstaller/parseMedia/11.1|JInstaller::parseMedia]]
+
** [[JInstallerComponent::uninstall/11.1|JInstallerComponent::uninstall]]
* [[JInstallerComponent/uninstall/11.1|JInstallerComponent::uninstall]]
+
** [[JInstallerFile::uninstall/11.1|JInstallerFile::uninstall]]
* [[JInstallerFile/uninstall/11.1|JInstallerFile::uninstall]]
+
** [[JInstallerHelper::unpack/11.1|JInstallerHelper::unpack]]
* [[JInstallerHelper/unpack/11.1|JInstallerHelper::unpack]]
+
** [[JInstallerComponent::update/11.1|JInstallerComponent::update]]
* [[JInstallerComponent/update/11.1|JInstallerComponent::update]]
+
** [[JFile::upload/11.1|JFile::upload]]
* [[JFile/upload/11.1|JFile::upload]]
+
** [[JFile::write/11.1|JFile::write]]
* [[JFile/write/11.1|JFile::write]]
+
 
===See also===
 
===See also===
 +
* {{JVer|11.1}} '''JPath::clean source code''' on [[jplatform:filesystem/path.php#cl-159|BitBucket]]
 +
* {{JVer|11.1}} Class [[JPath/11.1|JPath]]
 +
* {{JVer|11.1}} Subpackage [[Subpackage_Filesystem/11.1|Filesystem]]
 +
* [[JPath::clean|Other versions of JPath::clean]]
 +
{{SeeAlso:JPath::clean}}
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
 
<nowiki>[</nowiki>[[SeeAlso:JPath::clean|Edit See Also]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[SeeAlso:JPath::clean|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
* [[JPath/11.1|JPath]]
+
===User contributed notes===
* [[JPath::clean|Other versions of this method]]
+
{{SeeAlso:JPath::clean}}
+
===Examples===
+
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 90: Line 91:
 
category=MethodExample
 
category=MethodExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:JPath]][[Category:JPath::clean]]</noinclude>
 
<noinclude>[[Category:JPath]][[Category:JPath::clean]]</noinclude>

Revision as of 21:29, 27 April 2011

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Joomla 11.1 JPath::clean

Description

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

Description:JPath::clean [Edit Descripton]

public static function clean (
        $path
        $ds=DIRECTORY_SEPARATOR
)
Parameter Type Default Description
$path string The path to clean
$ds string DIRECTORY_SEPARATOR Directory separator (optional)

See also

SeeAlso:JPath::clean [Edit See Also]

User contributed notes

<CodeExamplesForm />