API17

Difference between revisions of "JPath::clean"

From Joomla! Documentation

(Bulk upload by Doxiki2)
 
m (moving preparation)
(4 intermediate revisions by 2 users 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===
+
** [[API17:JArchiveZip::_extract|JArchiveZip::_extract]]
−
* [[JArchiveZip/_extract/11.1|JArchiveZip::_extract]]
+
** [[API17:JElementModuleLayouts::_getOptions|JElementModuleLayouts::_getOptions]]
−
* [[JElementModuleLayouts/_getOptions/11.1|JElementModuleLayouts::_getOptions]]
+
** [[API17:JElementComponentLayouts::_getOptions|JElementComponentLayouts::_getOptions]]
−
* [[JElementComponentLayouts/_getOptions/11.1|JElementComponentLayouts::_getOptions]]
+
** [[API17:JHtml::addIncludePath|JHtml::addIncludePath]]
−
* [[JHtml/addIncludePath/11.1|JHtml::addIncludePath]]
+
** [[API17:JCacheStorage::addIncludePath|JCacheStorage::addIncludePath]]
−
* [[JCacheStorage/addIncludePath/11.1|JCacheStorage::addIncludePath]]
+
** [[API17:JCache::addIncludePath|JCache::addIncludePath]]
−
* [[JCache/addIncludePath/11.1|JCache::addIncludePath]]
+
** [[API17:JModel::addIncludePath|JModel::addIncludePath]]
−
* [[JModel/addIncludePath/11.1|JModel::addIncludePath]]
+
** [[API17:JCacheController::addIncludePath|JCacheController::addIncludePath]]
−
* [[JCacheController/addIncludePath/11.1|JCacheController::addIncludePath]]
+
** [[check|check]]
−
* [[check/11.1|check]]
+
** [[API17:JInstallerHelper::cleanupInstall|JInstallerHelper::cleanupInstall]]
−
* [[JInstallerHelper/cleanupInstall/11.1|JInstallerHelper::cleanupInstall]]
+
** [[API17:JFolder::copy|JFolder::copy]]
−
* [[JFolder/copy/11.1|JFolder::copy]]
+
** [[API17:JFile::copy|JFile::copy]]
−
* [[JFile/copy/11.1|JFile::copy]]
+
** [[API17:JInstaller::copyFiles|JInstaller::copyFiles]]
−
* [[JInstaller/copyFiles/11.1|JInstaller::copyFiles]]
+
** [[API17:JFolder::create|JFolder::create]]
−
* [[JFolder/create/11.1|JFolder::create]]
+
** [[API17:JFolder::delete|JFolder::delete]]
−
* [[JFolder/delete/11.1|JFolder::delete]]
+
** [[API17:JFile::delete|JFile::delete]]
−
* [[JFile/delete/11.1|JFile::delete]]
+
** [[API17:JInstallerComponent::discover_install|JInstallerComponent::discover_install]]
−
* [[JInstallerComponent/discover_install/11.1|JInstallerComponent::discover_install]]
+
** [[API17:JFolder::exists|JFolder::exists]]
−
* [[JFolder/exists/11.1|JFolder::exists]]
+
** [[API17:JFile::exists|JFile::exists]]
−
* [[JFile/exists/11.1|JFile::exists]]
+
** [[API17:JArchiveTar::extract|JArchiveTar::extract]]
−
* [[JArchiveTar/extract/11.1|JArchiveTar::extract]]
+
** [[API17:JArchive::extract|JArchive::extract]]
−
* [[JArchive/extract/11.1|JArchive::extract]]
+
** [[API17:JFolder::files|JFolder::files]]
−
* [[JFolder/files/11.1|JFolder::files]]
+
** [[API17:JFolder::folders|JFolder::folders]]
−
* [[JFolder/folders/11.1|JFolder::folders]]
+
** [[API17:JFormFieldModuleLayout::getInput|JFormFieldModuleLayout::getInput]]
−
* [[JFormFieldModuleLayout/getInput/11.1|JFormFieldModuleLayout::getInput]]
+
** [[API17:JFormFieldComponentLayout::getInput|JFormFieldComponentLayout::getInput]]
−
* [[JFormFieldComponentLayout/getInput/11.1|JFormFieldComponentLayout::getInput]]
+
** [[getPermissions|getPermissions]]
−
* [[getPermissions/11.1|getPermissions]]
+
** [[API17:JInstallerComponent::install|JInstallerComponent::install]]
−
* [[JInstallerComponent/install/11.1|JInstallerComponent::install]]
+
** [[API17:JInstallerFile::install|JInstallerFile::install]]
−
* [[JInstallerFile/install/11.1|JInstallerFile::install]]
+
** [[API17:JFolder::listFolderTree|JFolder::listFolderTree]]
−
* [[JFolder/listFolderTree/11.1|JFolder::listFolderTree]]
+
** [[API17:JFolder::move|JFolder::move]]
−
* [[JFolder/move/11.1|JFolder::move]]
+
** [[API17:JFile::move|JFile::move]]
−
* [[JFile/move/11.1|JFile::move]]
+
** [[API17:JInstaller::parseMedia|JInstaller::parseMedia]]
−
* [[JInstaller/parseMedia/11.1|JInstaller::parseMedia]]
+
** [[API17:JInstallerComponent::uninstall|JInstallerComponent::uninstall]]
−
* [[JInstallerComponent/uninstall/11.1|JInstallerComponent::uninstall]]
+
** [[API17:JInstallerFile::uninstall|JInstallerFile::uninstall]]
−
* [[JInstallerFile/uninstall/11.1|JInstallerFile::uninstall]]
+
** [[API17:JInstallerHelper::unpack|JInstallerHelper::unpack]]
−
* [[JInstallerHelper/unpack/11.1|JInstallerHelper::unpack]]
+
** [[API17:JInstallerComponent::update|JInstallerComponent::update]]
−
* [[JInstallerComponent/update/11.1|JInstallerComponent::update]]
+
** [[API17:JFile::upload|JFile::upload]]
−
* [[JFile/upload/11.1|JFile::upload]]
+
** [[API17:JFile::write|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 [[API17:JPath|JPath]]
 +
* {{JVer|11.1}} Subpackage [[API17:Subpackage_Filesystem|Filesystem]]
 +
* [[API17: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:Platform 11.1]][[Category:Archived pages API17]]</noinclude>

Revision as of 21:19, 11 May 2013

The "API17" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Joomla 11.1 JPath::clean[edit]

Description[edit]

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

Template: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[edit]

Template:SeeAlso:JPath::clean [Edit See Also]

User contributed notes[edit]

<CodeExamplesForm />


Retrieved from "https://docs.joomla.org/index.php?title=API17:JPath::clean&oldid=96579"