API16

JFile/makeSafe: Difference between revisions

From Joomla! Documentation

m clean up
m preparing for archive only
 
Line 40: Line 40:


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=makeSafe
  category=makeSafe
  category=JFile
  category=JFile
  category=CodeExample
  namespace=CodeExample
  category=MethodExample
  category=MethodExample
  include=*
  include=*

Latest revision as of 01:39, 25 March 2017

Description

Makes file name safe to use


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

Syntax

makeSafe($file)
Parameter Name Default Value Description
$file $file The name of the file [not full path]

Returns

string The sanitised string

Defined in

libraries/joomla/filesystem/file.php

Importing

jimport( 'joomla.filesystem.file' );

Source Body

function makeSafe($file) {
        $regex = array('#(\.){2,}#', '#[^A-Za-z0-9\.\_\- ]#', '#^\.#');
        return preg_replace($regex, '', $file);
}


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

Examples

Code Examples