JPath::clean/1.5

JPath::clean

Description

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

public function clean (
        $path
        $ds=DS
)

Parameter	Type	Default	Description
$path	string		The path to clean
$ds	string	DS	Directory separator (optional)

• Returns string The cleaned path
• Defined on line 169 of libraries/joomla/filesystem/path.php
• Since
• Referenced by
  • JArchiveZip::_extract
  • JHTML::addIncludePath
  • JModel::addIncludePath
  • check
  • JInstallerHelper::cleanupInstall
  • JFolder::copy
  • JFile::copy
  • JInstaller::copyFiles
  • JFolder::create
  • JFolder::delete
  • JFile::delete
  • JFolder::exists
  • JFile::exists
  • JArchiveTar::extract
  • JArchive::extract
  • JFolder::files
  • JFolder::folders
  • JLog::getInstance
  • getPermissions
  • JInstallerComponent::install
  • JFolder::listFolderTree
  • JFolder::move
  • JFile::move
  • JInstaller::parseMedia
  • JInstallerComponent::uninstall
  • JInstallerHelper::unpack
  • JFile::upload
  • JFile::write

See also

• JPath::clean on api.joomla.org
• JPath source code on JoomlaCode
• Class JPath
• Subpackage Filesystem
• Other versions of JPath::clean

User contributed notes

<CodeExamplesForm />