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 FOFIntegrationJoomlaFilesystem
+ Graphe d'héritage de FOFIntegrationJoomlaFilesystem:

Fonctions membres publiques

 __construct ()
 
 fileExists ($path)
 
 fileDelete ($file)
 
 fileCopy ($src, $dest, $path=null, $use_streams=false)
 
 fileWrite ($file, &$buffer, $use_streams=false)
 
 pathCheck ($path)
 
 pathClean ($path, $ds=DIRECTORY_SEPARATOR)
 
 pathFind ($paths, $file)
 
 folderExists ($path)
 
 folderFiles ($path, $filter='.', $recurse=false, $full=false, $exclude=array('.svn', 'CVS', '.DS_Store', '__MACOSX'), $excludefilter=array('^\..*', '.*~'), $naturalSort=false)
 
 folderFolders ($path, $filter='.', $recurse=false, $full=false, $exclude=array('.svn', 'CVS', '.DS_Store', '__MACOSX'), $excludefilter=array('^\..*'))
 
 folderCreate ($path='', $mode=0755)
 
- Fonctions membres publiques hérités de FOFPlatformFilesystem
 getExt ($file)
 
 stripExt ($file)
 
- Fonctions membres publiques hérités de FOFPlatformFilesystemInterface
 fileCopy ($src, $dest)
 
 fileWrite ($file, &$buffer)
 
 folderFiles ($path, $filter='.', $recurse=false, $full=false, $exclude=array('.svn', 'CVS', '.DS_Store', '__MACOSX'), $excludefilter=array('^\..*', '.*~'))
 

Membres hérités additionnels

- Fonctions membres protégées statiques hérités de FOFPlatformFilesystem
static getFiles ($path, array $ignoreFolders=array(), array $ignoreFiles=array())
 
static scanDirectory ($path, array $ignoreFolders=array(), array $ignoreFiles=array())
 
- Attributs protégés statiques hérités de FOFPlatformFilesystem
static $paths = array()
 

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( )

Références JLoader\import().

Documentation des fonctions membres

◆ fileCopy()

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

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
@return  boolean  True on success

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

◆ fileDelete()

fileDelete (   $file)

Delete a file or array of files

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

Implémente FOFPlatformFilesystemInterface.

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

◆ fileExists()

fileExists (   $path)

Does the file exists?

Paramètres
$pathstring Path to the file to test
Renvoie
bool

Implémente FOFPlatformFilesystemInterface.

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

◆ fileWrite()

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

Write contents to a file

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

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

◆ folderCreate()

folderCreate (   $path = '',
  $mode = 0755 
)

Create a folder – and all necessary parent folders.

Paramètres
string$pathA path to create from the base path.
integer$modeDirectory permissions to set for folders created. 0755 by default.
Renvoie
boolean True if successful.

Implémente FOFPlatformFilesystemInterface.

Références $mode, $path, et JFolder\create().

◆ folderExists()

folderExists (   $path)

Wrapper for the standard file_exists function

Paramètres
string$pathFolder name relative to installation dir
Renvoie
boolean True if path is a folder

Implémente FOFPlatformFilesystemInterface.

Références $path, et JFolder\exists().

◆ folderFiles()

folderFiles (   $path,
  $filter = '.',
  $recurse = false,
  $full = false,
  $exclude = array('.svn', 'CVS', '.DS_Store', '__MACOSX'),
  $excludefilter = array('^\..*', '.*~'),
  $naturalSort = false 
)

Utility function to read the files in a folder.

Paramètres
string$pathThe path of the folder to read.
string$filterA filter for file names.
mixed$recurseTrue to recursively search into sub-folders, or an integer to specify the maximum depth.
boolean$fullTrue to return the full path to the file.
array$excludeArray with names of files which should not be shown in the result.
array$excludefilterArray of filter to exclude
boolean$naturalSortFalse for asort, true for natsort
@return  array  Files in the given folder.

Références $filter, $path, et JFolder\files().

◆ folderFolders()

folderFolders (   $path,
  $filter = '.',
  $recurse = false,
  $full = false,
  $exclude = array('.svn', 'CVS', '.DS_Store', '__MACOSX'),
  $excludefilter = array('^\..*') 
)

Utility function to read the folders in a folder.

Paramètres
string$pathThe path of the folder to read.
string$filterA filter for folder names.
mixed$recurseTrue to recursively search into sub-folders, or an integer to specify the maximum depth.
boolean$fullTrue to return the full path to the folders.
array$excludeArray with names of folders which should not be shown in the result.
array$excludefilterArray with regular expressions matching folders which should not be shown in the result.
Renvoie
array Folders in the given folder.

Implémente FOFPlatformFilesystemInterface.

Références $filter, $path, et JFolder\folders().

◆ pathCheck()

pathCheck (   $path)

Checks for snooping outside of the file system root.

Paramètres
string$pathA file system path to check.
Renvoie
string A cleaned version of the path or exit on error.
Exceptions
Exception

Implémente FOFPlatformFilesystemInterface.

Références $path, et JPath\check().

◆ pathClean()

pathClean (   $path,
  $ds = DIRECTORY_SEPARATOR 
)

Function to strip additional / or \ in a path name.

Paramètres
string$pathThe path to clean.
string$dsDirectory separator (optional).
Renvoie
string The cleaned path.
Exceptions
UnexpectedValueException

Implémente FOFPlatformFilesystemInterface.

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

◆ pathFind()

pathFind (   $paths,
  $file 
)

Searches the directory paths for a given file.

Paramètres
mixed$pathsAn path string or array of path strings to search in
string$fileThe file name to look for.
Renvoie
mixed The full path and file name for the target file, or boolean false if the file is not found in any of the paths.

Implémente FOFPlatformFilesystemInterface.

Références $file, et JPath\find().


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