Actions

API15

JPath/clean

From Joomla! Documentation

< API15:JPath
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.

Contents

Description

Function to strip additional / or \ in a path name

[<! removed edit link to red link >]

<! removed transcluded page call, red link never existed >

Syntax

clean($path, $ds=DS)
Parameter Name Default Value Description
$path $path The path to clean
$ds DS $ds Directory separator (optional)

Returns

string The cleaned path

Defined in

libraries/joomla/filesystem/path.php

Importing

jimport( 'joomla.filesystem.path' );

Source Body

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

<CodeExamplesForm />