JFile::makeSafe: Difference between revisions

Revision as of 01:56, 28 April 2011

Makes file name safe to use.

public static function makeSafe ($file)

Parameter	Type	Default	Description
$file	string		The name of the file [not full path]

@@ Line 8: / Line 8: @@
 <nowiki>[</nowiki>[[Description:JFile::makeSafe|Edit Descripton]]<nowiki>]</nowiki>
 </span>
-===Since===
-{{JVer|11.1 }}
-===Synopsis===
 <source lang="php">
-public static JFile::makeSafe ($file)
+public static function makeSafe ($file)
 </source>
 {| class="wikitable"
@@ Line 27: / Line 24: @@
 |-
 |}
-===Returns===
+* '''Returns''' string The sanitised string
-string The sanitised string
+* '''Defined''' on line 60 of libraries/joomla/filesystem/file.php
-===Defined in===
+* '''Since''' {{JVer|11.1 }}
-libraries/joomla/filesystem/file.php (line 60)
-* see source code in [[jplatform:filesystem/file.php#cl-60|BitBucket]]
-===Referenced by===
 ===See also===
+* {{JVer|11.1}} '''JFile::makeSafe source code''' on [[jplatform:filesystem/file.php#cl-52|BitBucket]]
+* {{JVer|11.1}} Class [[JFile/11.1|JFile]]
+* {{JVer|11.1}} Subpackage [[Subpackage_Filesystem/11.1|Filesystem]]
+* [[JFile::makeSafe|Other versions of JFile::makeSafe]]
+{{SeeAlso:JFile::makeSafe}}
 <span class="editsection" style="font-size:76%;">
 <nowiki>[</nowiki>[[SeeAlso:JFile::makeSafe|Edit See Also]]<nowiki>]</nowiki>
 </span>
-* [[JFile/11.1|JFile]]
+===User contributed notes===
-* [[JFile::makeSafe|Other versions of this method]]
-{{SeeAlso:JFile::makeSafe}}
-===Examples===
 <CodeExamplesForm />
 <dpl>
@@ Line 48: / Line 44: @@
 category=MethodExample
 include=*
+namespace=CodeExample
 format= ,,,
 </dpl>
 <noinclude>[[Category:JFile]][[Category:JFile::makeSafe]]</noinclude>