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 JFilesystemWrapperFile

Fonctions membres publiques

 getExt ($file)
 
 stripExt ($file)
 
 makeSafe ($file)
 
 copy ($src, $dest, $path=null, $use_streams=false)
 
 delete ($file)
 
 move ($src, $dest, $path='', $use_streams=false)
 
 read ($filename, $incpath=false, $amount=0, $chunksize=8192, $offset=0)
 
 write ($file, &$buffer, $use_streams=false)
 
 upload ($src, $dest, $use_streams=false)
 
 exists ($file)
 
 getName ($file)
 

Documentation des fonctions membres

◆ copy()

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

Helper wrapper method for copy

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.
Voir également
JFile::copy()
Depuis
3.4

Références $path, et JFile\copy().

◆ delete()

delete (   $file)

Helper wrapper method for delete

Paramètres
mixed$fileThe file name or an array of file names
Renvoie
boolean True on success.
Voir également
JFile::delete()
Depuis
3.4

Références $file, et JFile\delete().

◆ exists()

exists (   $file)

Helper wrapper method for exists

Paramètres
string$fileFile path.
Renvoie
boolean True if path is a file.
Voir également
JFile::exists()
Depuis
3.4

Références $file, et JFile\exists().

◆ getExt()

getExt (   $file)

Helper wrapper method for getExt

Paramètres
string$fileThe file name.
Renvoie
string The file extension.
Voir également
JFile::getExt()
Depuis
3.4

Références $file, et JFile\getExt().

◆ getName()

getName (   $file)

Helper wrapper method for getName

Paramètres
string$fileFile path.
Renvoie
string filename.
Voir également
JFile::getName()
Depuis
3.4

Références $file, et JFile\getName().

◆ makeSafe()

makeSafe (   $file)

Helper wrapper method for makeSafe

Paramètres
string$fileThe name of the file [not full path].
Renvoie
string The sanitised string.
Voir également
JFile::makeSafe()
Depuis
3.4

Références $file, et JFile\makeSafe().

◆ move()

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

Helper wrapper method for move

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.
Voir également
JFile::move()
Depuis
3.4

Références $path, et JFile\move().

◆ read()

read (   $filename,
  $incpath = false,
  $amount = 0,
  $chunksize = 8192,
  $offset = 0 
)

Helper wrapper method for read

Paramètres
string$filenameThe full file path.
boolean$incpathUse include path.
integer$amountAmount of file to read.
integer$chunksizeSize of chunks to read.
integer$offsetOffset of the file.
Renvoie
mixed Returns file contents or boolean False if failed.
Voir également
JFile::read()
Depuis
3.4

Références $offset, et JFile\read().

◆ stripExt()

stripExt (   $file)

Helper wrapper method for stripExt

Paramètres
string$fileThe file name.
Renvoie
string The file name without the extension.
Voir également
JFile::stripExt()
Depuis
3.4

Références $file, et JFile\stripExt().

◆ upload()

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

Helper wrapper method for upload

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.
Voir également
JFile::upload()
Depuis
3.4

Références JFile\upload().

◆ write()

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

Helper wrapper method for write

Paramètres
string$fileThe full file path.
string&$bufferThe buffer to write.
boolean$use_streamsUse streams.
Renvoie
boolean True on success.
Voir également
JFile::write()
Depuis
3.4

Références $buffer, $file, et JFile\write().


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