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 JFile

Fonctions membres publiques statiques

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

Description détaillée

A File handling class

Depuis
11.1

Documentation des fonctions membres

◆ append()

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

Append 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
3.6.0

Références $buffer, $file, JPath\clean(), et JPATH_ROOT.

Référencé par FormattedtextLogger\addEntry().

◆ 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
11.1

Références $path, JFilesystemWrapperPath\clean(), JFilesystemWrapperFolder\create(), et JPATH_ROOT.

Référencé par JFilesystemWrapperFile\copy(), FOFUtilsInstallscript\copyCliFiles(), TemplatesModelTemplate\copyFile(), Installer\copyFiles(), TemplatesModelTemplate\createTemplateOverride(), et FOFIntegrationJoomlaFilesystem\fileCopy().

◆ delete()

◆ exists()

◆ getExt()

static getExt (   $file)
static

Gets the extension of a file name

Paramètres
string$fileThe file name
Renvoie
string The file extension
Depuis
11.1

Références $file.

Référencé par TemplateHelper\canUpload(), TemplatesModelTemplate\createTemplateOverride(), JFilesystemWrapperFile\getExt(), MediaModelList\getList(), JGoogleDataPicasaAlbum\getMime(), HTMLHelper\includeRelativeFiles(), et JStream\open().

◆ getName()

static getName (   $file)
static

Returns the name, without any path.

Paramètres
string$fileFile path
Renvoie
string filename
Depuis
11.1
Obsolète:
13.3 (Platform) & 4.0 (CMS) - Use basename() instead.

Références $file.

Référencé par JFilesystemWrapperFile\getName(), Installer\parseXMLInstallFile(), et JGoogleDataPicasaAlbum\upload().

◆ makeSafe()

static makeSafe (   $file)
static

Makes file name safe to use

Paramètres
string$fileThe name of the file [not full path]
Renvoie
string The sanitised string
Depuis
11.1

Références $file.

Référencé par TemplateHelper\canUpload(), MediaHelper\canUpload(), ContenthistoryHelper\getFormFile(), JFilesystemWrapperFile\makeSafe(), MediaControllerFile\upload(), et TemplatesModelTemplate\uploadFile().

◆ 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
11.1

Références $path, JFilesystemWrapperPath\clean(), et JPATH_ROOT.

Référencé par InstallationControllerRemovefolder\execute(), TemplatesModelTemplate\fixTemplateName(), JFilesystemWrapperFile\move(), et InstallerScript\moveCliFiles().

◆ read()

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

Read the contents of a file

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
Depuis
11.1
Obsolète:
13.3 (Platform) & 4.0 (CMS) - Use the native file_get_contents() instead.

Références $data, $offset, et null.

Référencé par FOFUtilsInstallscript\installFOF(), FOFUtilsInstallscript\installStrapper(), et JFilesystemWrapperFile\read().

◆ stripExt()

◆ upload()

static upload (   $src,
  $dest,
  $use_streams = false,
  $allow_unsafe = false,
  $safeFileOptions = array() 
)
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
boolean$allow_unsafeAllow the upload of unsafe files
boolean$safeFileOptionsOptions to JFilterInput::isSafeFile
Renvoie
boolean True on success
Depuis
11.1

Références $baseDir, JFilesystemWrapperPath\clean(), JFilesystemWrapperFolder\create(), et JPATH_ROOT.

Référencé par InstallerModelInstall\_getPackageFromUpload(), MediaControllerFile\upload(), JFilesystemWrapperFile\upload(), JoomlaupdateModelDefault\upload(), et TemplatesModelTemplate\uploadFile().

◆ write()


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