Difference between revisions of "JFile::makeSafe"

Latest revision as of 22:01, 24 March 2017

The "API17" 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.

JFile::makeSafe[edit]

Description[edit]

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]

Returns string The sanitised string
Defined on line 60 of libraries/joomla/filesystem/file.php
Since

User contributed notes[edit]

Example[edit]

		//Retrieve file details from uploaded file, sent from upload form
		$file = JRequest::getVar('upload_file', null, 'files', 'array');
				
		//Import filesystem libraries. Perhaps not necessary, but does not hurt
		jimport('joomla.filesystem.file');
 
		//Clean up filename to get rid of strange characters like spaces etc
		$filename = JFile::makeSafe($file['name']);

Code Examples[edit]

@@ Line 4: / Line 4: @@
 Makes file name safe to use.
-{{Description:JFile::makeSafe}}
-<span class="editsection" style="font-size:76%;">
-<nowiki>[</nowiki>[[Description:JFile::makeSafe|Edit Descripton]]<nowiki>]</nowiki>
-</span>
 <source lang="php">
 public static function makeSafe ($file)
@@ Line 29: / Line 27: @@
 ===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}} Class [[API17:JFile|JFile]]
-* {{JVer|11.1}} Subpackage [[Subpackage_Filesystem/11.1|Filesystem]]
+* {{JVer|11.1}} Subpackage [[API17:Subpackage_Filesystem|Filesystem]]
-* [[JFile::makeSafe|Other versions of JFile::makeSafe]]
+* [[API17: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>
 ===User contributed notes===
-<CodeExamplesForm />
+===Example===
+<source lang="php">
+		//Retrieve file details from uploaded file, sent from upload form
+		$file = JRequest::getVar('upload_file', null, 'files', 'array');
+		//Import filesystem libraries. Perhaps not necessary, but does not hurt
+		jimport('joomla.filesystem.file');
+		//Clean up filename to get rid of strange characters like spaces etc
+		$filename = JFile::makeSafe($file['name']);
+</source>
+=== Code Examples ===
 <dpl>
 noresultsheader=\n
 category=JFile::makeSafe
-category=CodeExample
+namespace=CodeExample
 category=MethodExample
 include=*
@@ Line 47: / Line 56: @@
 format= ,,,
 </dpl>
-<noinclude>[[Category:JFile]][[Category:JFile::makeSafe]]</noinclude>
+<noinclude>[[Category:Platform 11.1]][[Category:Archived pages API17]]</noinclude>

API17