JFile::makeSafe: Difference between revisions
From Joomla! Documentation
m →Example: moving preparation |
m preparing for archive only |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 4: | Line 4: | ||
Makes file name safe to use. | Makes file name safe to use. | ||
<source lang="php"> | <source lang="php"> | ||
public static function makeSafe ($file) | public static function makeSafe ($file) | ||
| Line 29: | Line 27: | ||
===See also=== | ===See also=== | ||
* {{JVer|11.1}} '''JFile::makeSafe source code''' on [[jplatform:filesystem/file.php#cl-52|BitBucket]] | * {{JVer|11.1}} '''JFile::makeSafe source code''' on [[jplatform:filesystem/file.php#cl-52|BitBucket]] | ||
* {{JVer|11.1}} Class [[JFile | * {{JVer|11.1}} Class [[API17:JFile|JFile]] | ||
* {{JVer|11.1}} Subpackage [[Subpackage_Filesystem | * {{JVer|11.1}} Subpackage [[API17:Subpackage_Filesystem|Filesystem]] | ||
* [[JFile::makeSafe|Other versions of JFile::makeSafe]] | * [[API17:JFile::makeSafe|Other versions of JFile::makeSafe]] | ||
===User contributed notes=== | ===User contributed notes=== | ||
===Example=== | ===Example=== | ||
| Line 50: | Line 46: | ||
=== Code Examples === | |||
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=JFile::makeSafe | category=JFile::makeSafe | ||
namespace=CodeExample | |||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
Latest revision as of 03:01, 25 March 2017
JFile::makeSafe
Description
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
See also
- JFile::makeSafe source code on BitBucket
- Class JFile
- Subpackage Filesystem
- Other versions of JFile::makeSafe
User contributed notes
Example
//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