Joomla CMS  3.8.5 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.8.5 et du framework Joomla Platform intégré
Référence de la classe File

Fonctions membres publiques statiques

static stripExt ($file)
 
static makeSafe ($file, array $stripChars=array('#^\.#'))
 
static copy ($src, $dest, $path=null, $use_streams=false)
 
static delete ($file)
 
static move ($src, $dest, $path='', $use_streams=false)
 
static write ($file, &$buffer, $use_streams=false)
 
static upload ($src, $dest, $use_streams=false)
 

Description détaillée

A File handling class

Depuis
1.0

Documentation des fonctions membres

◆ copy()

static copy (   $src,
  $dest,
  $path = null,
  $use_streams = false 
)
static

Copies a file

Paramètres
string$srcThe path to the source file
string$destThe path to the destination file
string$pathAn optional base path to prefix to the file names
boolean$use_streamsTrue to use streams
Renvoie
boolean True on success
Depuis
1.0
Exceptions
FilesystemException

Références $path, Path\clean(), et Stream\getStream().

Référencé par Archive\extract().

◆ delete()

static delete (   $file)
static

Delete a file or array of files

Paramètres
mixed$fileThe file name or an array of file names
Renvoie
boolean True on success
Depuis
1.0
Exceptions
FilesystemException

Références $file, $files, et Path\clean().

Référencé par Patcher\apply(), Folder\delete(), et Path\isOwner().

◆ makeSafe()

static makeSafe (   $file,
array  $stripChars = array('#^\.#') 
)
static

Makes the file name safe to use

Paramètres
string$fileThe name of the file [not full path]
array$stripCharsArray of regex (by default will remove any leading periods)
Renvoie
string The sanitised string
Depuis
1.0

Références $file.

◆ move()

static move (   $src,
  $dest,
  $path = '',
  $use_streams = false 
)
static

Moves a file

Paramètres
string$srcThe path to the source file
string$destThe path to the destination file
string$pathAn optional base path to prefix to the file names
boolean$use_streamsTrue to use streams
Renvoie
boolean True on success
Depuis
1.0
Exceptions
FilesystemException

Références $path, Path\clean(), et Stream\getStream().

◆ stripExt()

static stripExt (   $file)
static

Strips the last extension off of a file name

Paramètres
string$fileThe file name
Renvoie
string The file name without the extension
Depuis
1.0

Références $file.

◆ upload()

static upload (   $src,
  $dest,
  $use_streams = false 
)
static

Moves an uploaded file to a destination folder

Paramètres
string$srcThe name of the php (temporary) uploaded file
string$destThe path (including filename) to move the uploaded file to
boolean$use_streamsTrue to use streams
Renvoie
boolean True on success
Depuis
1.0
Exceptions
FilesystemException

Références $baseDir, Path\clean(), Folder\create(), Stream\getStream(), et Path\setPermissions().

◆ write()

static write (   $file,
$buffer,
  $use_streams = false 
)
static

Write contents to a file

Paramètres
string$fileThe full file path
string&$bufferThe buffer to write
boolean$use_streamsUse streams
Renvoie
boolean True on success
Depuis
1.0

Références $buffer, $file, Path\clean(), Folder\create(), et Stream\getStream().

Référencé par Patcher\apply(), Zip\createZipFile(), Bzip2\extract(), Gzip\extract(), Tar\extract(), Zip\extractCustom(), Zip\extractNative(), et Path\isOwner().


La documentation de cette classe a été générée à partir du fichier suivant :