Difference between revisions of "JPath::clean"
From Joomla! Documentation
(Updated to r1448:247ba8d88526) |
m (preparing for archive only) |
||
(4 intermediate revisions by the same user not shown) | |||
Line 4: | Line 4: | ||
Function to strip additional / or \ in a path name. | Function to strip additional / or \ in a path name. | ||
− | + | ||
− | + | ||
− | |||
− | |||
<source lang="php"> | <source lang="php"> | ||
public static function clean ( | public static function clean ( | ||
Line 36: | Line 34: | ||
* '''Since''' {{JVer|11.1 }} | * '''Since''' {{JVer|11.1 }} | ||
* '''Referenced by''' | * '''Referenced by''' | ||
− | ** [[JArchiveZip::_extract | + | ** [[API17:JArchiveZip::_extract|JArchiveZip::_extract]] |
− | ** [[JElementModuleLayouts::_getOptions | + | ** [[API17:JElementModuleLayouts::_getOptions|JElementModuleLayouts::_getOptions]] |
− | ** [[JElementComponentLayouts::_getOptions | + | ** [[API17:JElementComponentLayouts::_getOptions|JElementComponentLayouts::_getOptions]] |
− | ** [[JHtml::addIncludePath | + | ** [[API17:JHtml::addIncludePath|JHtml::addIncludePath]] |
− | ** [[JCacheStorage::addIncludePath | + | ** [[API17:JCacheStorage::addIncludePath|JCacheStorage::addIncludePath]] |
− | ** [[JCache::addIncludePath | + | ** [[API17:JCache::addIncludePath|JCache::addIncludePath]] |
− | ** [[JModel::addIncludePath | + | ** [[API17:JModel::addIncludePath|JModel::addIncludePath]] |
− | ** [[JCacheController::addIncludePath | + | ** [[API17:JCacheController::addIncludePath|JCacheController::addIncludePath]] |
− | ** [[check | + | ** [[check|check]] |
− | ** [[JInstallerHelper::cleanupInstall | + | ** [[API17:JInstallerHelper::cleanupInstall|JInstallerHelper::cleanupInstall]] |
− | ** [[JFolder::copy | + | ** [[API17:JFolder::copy|JFolder::copy]] |
− | ** [[JFile::copy | + | ** [[API17:JFile::copy|JFile::copy]] |
− | ** [[JInstaller::copyFiles | + | ** [[API17:JInstaller::copyFiles|JInstaller::copyFiles]] |
− | ** [[JFolder::create | + | ** [[API17:JFolder::create|JFolder::create]] |
− | ** [[JFolder::delete | + | ** [[API17:JFolder::delete|JFolder::delete]] |
− | ** [[JFile::delete | + | ** [[API17:JFile::delete|JFile::delete]] |
− | ** [[JInstallerComponent::discover_install | + | ** [[API17:JInstallerComponent::discover_install|JInstallerComponent::discover_install]] |
− | ** [[JFolder::exists | + | ** [[API17:JFolder::exists|JFolder::exists]] |
− | ** [[JFile::exists | + | ** [[API17:JFile::exists|JFile::exists]] |
− | ** [[JArchiveTar::extract | + | ** [[API17:JArchiveTar::extract|JArchiveTar::extract]] |
− | ** [[JArchive::extract | + | ** [[API17:JArchive::extract|JArchive::extract]] |
− | ** [[JFolder::files | + | ** [[API17:JFolder::files|JFolder::files]] |
− | ** [[JFolder::folders | + | ** [[API17:JFolder::folders|JFolder::folders]] |
− | ** [[JFormFieldModuleLayout::getInput | + | ** [[API17:JFormFieldModuleLayout::getInput|JFormFieldModuleLayout::getInput]] |
− | ** [[JFormFieldComponentLayout::getInput | + | ** [[API17:JFormFieldComponentLayout::getInput|JFormFieldComponentLayout::getInput]] |
− | ** [[getPermissions | + | ** [[getPermissions|getPermissions]] |
− | ** [[JInstallerComponent::install | + | ** [[API17:JInstallerComponent::install|JInstallerComponent::install]] |
− | ** [[JInstallerFile::install | + | ** [[API17:JInstallerFile::install|JInstallerFile::install]] |
− | ** [[JFolder::listFolderTree | + | ** [[API17:JFolder::listFolderTree|JFolder::listFolderTree]] |
− | ** [[JFolder::move | + | ** [[API17:JFolder::move|JFolder::move]] |
− | ** [[JFile::move | + | ** [[API17:JFile::move|JFile::move]] |
− | ** [[JInstaller::parseMedia | + | ** [[API17:JInstaller::parseMedia|JInstaller::parseMedia]] |
− | ** [[JInstallerComponent::uninstall | + | ** [[API17:JInstallerComponent::uninstall|JInstallerComponent::uninstall]] |
− | ** [[JInstallerFile::uninstall | + | ** [[API17:JInstallerFile::uninstall|JInstallerFile::uninstall]] |
− | ** [[JInstallerHelper::unpack | + | ** [[API17:JInstallerHelper::unpack|JInstallerHelper::unpack]] |
− | ** [[JInstallerComponent::update | + | ** [[API17:JInstallerComponent::update|JInstallerComponent::update]] |
− | ** [[JFile::upload | + | ** [[API17:JFile::upload|JFile::upload]] |
− | ** [[JFile::write | + | ** [[API17:JFile::write|JFile::write]] |
===See also=== | ===See also=== | ||
* {{JVer|11.1}} '''JPath::clean source code''' on [[jplatform:filesystem/path.php#cl-159|BitBucket]] | * {{JVer|11.1}} '''JPath::clean source code''' on [[jplatform:filesystem/path.php#cl-159|BitBucket]] | ||
− | * {{JVer|11.1}} Class [[JPath | + | * {{JVer|11.1}} Class [[API17:JPath|JPath]] |
− | * {{JVer|11.1}} Subpackage [[Subpackage_Filesystem | + | * {{JVer|11.1}} Subpackage [[API17:Subpackage_Filesystem|Filesystem]] |
− | * [[JPath::clean|Other versions of JPath::clean]] | + | * [[API17:JPath::clean|Other versions of JPath::clean]] |
− | + | ||
− | + | ||
− | |||
− | |||
===User contributed notes=== | ===User contributed notes=== | ||
− | + | === Code Examples === | |
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=JPath::clean | category=JPath::clean | ||
− | + | namespace=CodeExample | |
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
Line 94: | Line 90: | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
− | <noinclude>[[Category: | + | <noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude> |
Latest revision as of 22:32, 24 March 2017
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.
JPath::clean[edit]
Description[edit]
Function to strip additional / or \ in a path name.
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) |
- Returns string The cleaned path
- Defined on line 167 of libraries/joomla/filesystem/path.php
- Since
- Referenced by
- JArchiveZip::_extract
- JElementModuleLayouts::_getOptions
- JElementComponentLayouts::_getOptions
- JHtml::addIncludePath
- JCacheStorage::addIncludePath
- JCache::addIncludePath
- JModel::addIncludePath
- JCacheController::addIncludePath
- check
- JInstallerHelper::cleanupInstall
- JFolder::copy
- JFile::copy
- JInstaller::copyFiles
- JFolder::create
- JFolder::delete
- JFile::delete
- JInstallerComponent::discover_install
- JFolder::exists
- JFile::exists
- JArchiveTar::extract
- JArchive::extract
- JFolder::files
- JFolder::folders
- JFormFieldModuleLayout::getInput
- JFormFieldComponentLayout::getInput
- getPermissions
- JInstallerComponent::install
- JInstallerFile::install
- JFolder::listFolderTree
- JFolder::move
- JFile::move
- JInstaller::parseMedia
- JInstallerComponent::uninstall
- JInstallerFile::uninstall
- JInstallerHelper::unpack
- JInstallerComponent::update
- JFile::upload
- JFile::write
See also[edit]
- JPath::clean source code on BitBucket
- Class JPath
- Subpackage Filesystem
- Other versions of JPath::clean
User contributed notes[edit]
Code Examples[edit]