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 JFilesystemWrapperFolder

Fonctions membres publiques

 copy ($src, $dest, $path='', $force=false, $use_streams=false)
 
 create ($path='', $mode=493)
 
 delete ($path)
 
 move ($src, $dest, $path='', $use_streams=false)
 
 exists ($path)
 
 files ($path, $filter='.', $recurse=false, $full=false, $exclude=array('.svn', 'CVS', '.DS_Store', '__MACOSX'), $excludefilter=array('^\..*', '.*~'), $naturalSort=false)
 
 folders ($path, $filter='.', $recurse=false, $full=false, $exclude=array('.svn', 'CVS', '.DS_Store', '__MACOSX'), $excludefilter=array('^\..*'))
 
 listFolderTree ($path, $filter, $maxLevel=3, $level=0, $parent=0)
 
 makeSafe ($path)
 

Documentation des fonctions membres

◆ copy()

copy (   $src,
  $dest,
  $path = '',
  $force = false,
  $use_streams = false 
)

Helper wrapper method for copy

Paramètres
string$srcThe path to the source folder.
string$destThe path to the destination folder.
string$pathAn optional base path to prefix to the file names.
boolean$forceForce copy.
boolean$use_streamsOptionally force folder/file overwrites.
Renvoie
boolean True on success.
Voir également
JFolder::copy()
Depuis
3.4
Exceptions
RuntimeException

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

◆ create()

create (   $path = '',
  $mode = 493 
)

Helper wrapper method for create

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

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

Référencé par JFile\copy(), et JFile\upload().

◆ delete()

delete (   $path)

Helper wrapper method for delete

Paramètres
string$pathThe path to the folder to delete.
Renvoie
boolean True on success.
Voir également
JFolder::delete()
Depuis
3.4
Exceptions
UnexpectedValueException

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

◆ exists()

exists (   $path)

Helper wrapper method for exists

Paramètres
string$pathFolder name relative to installation dir.
Renvoie
boolean True if path is a folder.
Voir également
JFolder::exists()
Depuis
3.4

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

◆ files()

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

Helper wrapper method for files

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.
Renvoie
array Files in the given folder.
Voir également
JFolder::files()
Depuis
3.4

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

◆ folders()

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

Helper wrapper method for folders

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

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

◆ listFolderTree()

listFolderTree (   $path,
  $filter,
  $maxLevel = 3,
  $level = 0,
  $parent = 0 
)

Helper wrapper method for listFolderTree

Paramètres
string$pathThe path of the folder to read.
string$filterA filter for folder names.
integer$maxLevelThe maximum number of levels to recursively read, defaults to three.
integer$levelThe current level, optional.
integer$parentUnique identifier of the parent folder, if any.
Renvoie
array Folders in the given folder.
Voir également
JFolder::listFolderTree()
Depuis
3.4

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

◆ makeSafe()

makeSafe (   $path)

Helper wrapper method for makeSafe

Paramètres
string$pathThe full path to sanitise.
Renvoie
string The sanitised string
Voir également
JFolder::makeSafe()
Depuis
3.4

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

◆ move()

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

Helper wrapper method for move

Paramètres
string$srcThe path to the source folder.
string$destThe path to the destination folder.
string$pathAn optional base path to prefix to the file names.
boolean$use_streamsOptionally use streams.
Renvoie
mixed Error message on false or boolean true on success.
Voir également
JFolder::move()
Depuis
3.4

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


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