JPath/clean
From Joomla! Documentation
< API15:JPath
The "API15" 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.
Description[edit]
Function to strip additional / or \ in a path name
[<! removed edit link to red link >]
<! removed transcluded page call, red link never existed >
Syntax[edit]
clean($path, $ds=DS)
Parameter Name | Default Value | Description |
---|---|---|
$path | $path The path to clean | |
$ds | DS | $ds Directory separator (optional) |
Returns[edit]
string The cleaned path
Defined in[edit]
libraries/joomla/filesystem/path.php
Importing[edit]
jimport( 'joomla.filesystem.path' );
Source Body[edit]
function clean($path, $ds=DS)
{
$path = trim($path);
if (empty($path)) {
$path = JPATH_ROOT;
} else {
// Remove double slashes and backslahses and convert all slashes and backslashes to DS
$path = preg_replace('#[/\\\\]+#', $ds, $path);
}
return $path;
}
[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >
Examples[edit]
Code Examples[edit]