Actions

API16

JFolder/makeSafe

From Joomla! Documentation

< API16:JFolder
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

Makes path name safe to use.

[<! removed edit link to red link >]

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

Syntax

makeSafe($path)
Parameter Name Default Value Description
$path The full path to sanitise.

Returns

string The sanitised string.

Defined in

libraries/joomla/filesystem/folder.php

Importing

jimport( 'joomla.filesystem.folder' );

Source Body

function makeSafe($path)
{
        //$ds = (DS == '\\') ? '\\' . DS : DS;
        $regex = array('#[^A-Za-z0-9:_\\\/-]#');
        return preg_replace($regex, '', $path);
}

[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />