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

Fonctions membres protégées statiques
static	_items ($path, $filter, $recurse, $full, $exclude, $excludefilter_string, $findfiles)

Documentation des fonctions membres

static JFolder::_items	(	$path,
		$filter,
		$recurse,
		$full,
		$exclude,
		$excludefilter_string,
		$findfiles
	)

staticprotected

Function to read the files/folders in a folder.

Paramètres:

string	$path	The path of the folder to read.
string	$filter	A filter for file names.
mixed	$recurse	True to recursively search into sub-folders, or an integer to specify the maximum depth.
boolean	$full	True to return the full path to the file.
array	$exclude	Array with names of files which should not be shown in the result.
string	$excludefilter_string	Regexp of files to exclude
boolean	$findfiles	True to read the files, false to read the folders

Renvoie:: array Files.

Depuis:: 11.1

Références $file, $path, et DIRECTORY_SEPARATOR.

static JFolder::copy	(	$src,
		$dest,
		$path = `''`,
		$force = `false`,
		$use_streams = `false`
	)

static

Copy a folder.

Paramètres:

string	$src	The path to the source folder.
string	$dest	The path to the destination folder.
string	$path	An optional base path to prefix to the file names.
string	$force	Force copy.
boolean	$use_streams	Optionally force folder/file overwrites.

Renvoie:: mixed JError object on failure or boolean True on success.

Depuis:: 11.1

Références $file, $path, JText\_(), JPath\clean(), DIRECTORY_SEPARATOR, JClientHelper\getCredentials(), JFTP\getInstance(), JFactory\getStream(), jimport(), JPATH_ROOT, null, et JError\raiseError().

Référencé par TemplatesModelTemplate\copy(), et JInstaller\copyFiles().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

static JFolder::create	(	$path = `''`,
		$mode = `0755`
	)

static

Create a folder – and all necessary parent folders.

Paramètres:

string	$path	A path to create from the base path.
integer	$mode	Directory permissions to set for folders created. 0755 by default.

Renvoie:: boolean True if successful.

Depuis:: 11.1

Références $mode, $path, JText\_(), JPath\clean(), JClientHelper\getCredentials(), JFTP\getInstance(), jimport(), JPATH_ISWIN, JPATH_ROOT, null, et JError\raiseWarning().

Référencé par JArchiveZip\_extract(), JArchiveZip\_extractNative(), JInstallerLanguage\_install(), JFile\copy(), MediaControllerFolder\create(), JoomlaupdateModelDefault\createRestorationFile(), JArchive\extract(), JArchiveTar\extract(), JLoggerFormattedText\initFile(), JInstallerFile\install(), JInstallerLibrary\install(), JInstallerTemplate\install(), JInstallerPlugin\install(), JInstallerModule\install(), JInstallerComponent\install(), JInstaller\parseFiles(), JInstaller\parseLanguages(), JInstaller\parseMedia(), JInstallerComponent\update(), JFile\upload(), JFile\write(), et JApplicationDaemon\writeProcessIdFile().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

static JFolder::delete ( $path )

static

Delete a folder.

Paramètres:

string $path The path to the folder to delete.

Renvoie:: boolean True on success.

Depuis:: 11.1

Références $files, $folder, $path, JText\_(), JPath\clean(), JFile\delete(), elseif, JClientHelper\getCredentials(), JFTP\getInstance(), jimport(), JPATH_ROOT, null, JError\raiseWarning(), et JText\sprintf().

Référencé par JInstaller\abort(), JCacheStorageCachelite\clean(), TemplatesModelTemplate\cleanup(), JInstallerHelper\cleanupInstall(), TemplatesModelTemplate\copy(), MediaControllerFolder\delete(), MediaControllerFile\delete(), joomlaInstallerScript\deleteUnexistingFiles(), JInstaller\parseFiles(), JInstaller\removeFiles(), JInstallationControllerSetup\removeFolder(), JInstallerLibrary\uninstall(), JInstallerTemplate\uninstall(), JInstallerPackage\uninstall(), JInstallerFile\uninstall(), JInstallerLanguage\uninstall(), JInstallerPlugin\uninstall(), JInstallerModule\uninstall(), et JInstallerComponent\uninstall().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

static JFolder::exists ( $path )

static

Wrapper for the standard file_exists function

Paramètres:

string $path Folder name relative to installation dir

Renvoie:: boolean True if path is a folder

Depuis:: 11.1

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

Référencé par TemplatesModelTemplate\copy(), joomlaInstallerScript\deleteUnexistingFiles(), JLanguage\exists(), AdminModelHelp\getLangTag(), MenusModelMenutypes\getTypeOptionsFromLayouts(), MenusModelMenutypes\getTypeOptionsFromMVC(), JInstallerFile\install(), JInstaller\install(), JInstaller\parseLanguages(), JInstallerFile\populateFilesAndFolderList(), LanguagesModelStrings\refresh(), JInstaller\removeFiles(), JInstallerLibrary\uninstall(), JInstallerTemplate\uninstall(), JInstallerPackage\uninstall(), JInstallerLanguage\uninstall(), JInstallerHelper\unpack(), et JInstaller\update().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

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

static

Utility function to read the files in a folder.

Paramètres:

string	$path	The path of the folder to read.
string	$filter	A filter for file names.
mixed	$recurse	True to recursively search into sub-folders, or an integer to specify the maximum depth.
boolean	$full	True to return the full path to the file.
array	$exclude	Array with names of files which should not be shown in the result.
array	$excludefilter	Array of filter to exclude
boolean	$naturalSort	False for asort, true for natsort

Renvoie:: array Files in the given folder.

Depuis:: 11.1

Références $path, JPath\clean(), JError\raiseWarning(), et JText\sprintf().

Référencé par JElementModuleLayouts\_getOptions(), JElementComponentLayouts\_getOptions(), MediaControllerFolder\delete(), MediaControllerFile\delete(), JInstallerHelper\detectType(), JInstallerLibrary\discover(), JInstallerPlugin\discover(), JElementFilelist\fetchElement(), JInstaller\findManifest(), TemplatesModelTemplate\fixTemplateName(), JCacheStorageCachelite\getAll(), JDatabase\getConnectors(), BannersModelTracks\getContent(), TemplatesModelTemplate\getFiles(), JFormFieldModuleLayout\getInput(), JFormFieldComponentLayout\getInput(), JFilesystemHelper\getJStreams(), MediaModelList\getList(), JFormFieldSample\getOptions(), JFormFieldFileList\getOptions(), JCache\getStores(), JSession\getStores(), AdminModelHelp\getToc(), MenusModelMenutypes\getTypeOptionsFromLayouts(), JSchemaChangeset\getUpdateFiles(), JHtmlList\images(), JInstallationModelDatabase\initialise(), JAdapter\loadAllAdapters(), JInstaller\parseSchemaUpdates(), JLanguage\parseXMLLanguageFiles(), JInstallerFile\populateFilesAndFolderList(), LanguagesModelStrings\refresh(), JInstaller\setSchemaVersion(), JInstallerLibrary\uninstall(), JInstallerFile\uninstall(), JInstallerPlugin\uninstall(), et JInstallerHelper\unpack().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

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

static

Utility function to read the folders in a folder.

Paramètres:

string	$path	The path of the folder to read.
string	$filter	A filter for folder names.
mixed	$recurse	True to recursively search into sub-folders, or an integer to specify the maximum depth.
boolean	$full	True to return the full path to the folders.
array	$exclude	Array with names of folders which should not be shown in the result.
array	$excludefilter	Array with regular expressions matching folders which should not be shown in the result.

Renvoie:: array Folders in the given folder.

Depuis:: 11.1

Références $path, JPath\clean(), JError\raiseWarning(), et JText\sprintf().

Référencé par JTableMenu\check(), JInstallerTemplate\discover(), JInstallerLanguage\discover(), JInstallerModule\discover(), JInstallerPlugin\discover(), JInstallerComponent\discover(), JElementFolderlist\fetchElement(), JCacheStorageCachelite\getAll(), AdminModelSysInfo\getDirectory(), MediaModelManager\getFolderList(), LanguagesModelInstalled\getFolders(), MediaModelManager\getFolderTree(), MediaModelList\getList(), JInstallation\getLocaliseAdmin(), JFormFieldFolderList\getOptions(), JFormFieldDirectories\getOptions(), MenusModelMenutypes\getTypeOptionsFromLayouts(), MenusModelMenutypes\getTypeOptionsFromMVC(), JLanguage\parseLanguageFiles(), et JInstallerHelper\unpack().

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

static JFolder::listFolderTree	(	$path,
		$filter,
		$maxLevel = `3`,
		$level = `0`,
		$parent = `0`
	)

static

Lists folder in format suitable for tree display.

Paramètres:

string	$path	The path of the folder to read.
string	$filter	A filter for folder names.
integer	$maxLevel	The maximum number of levels to recursively read, defaults to three.
integer	$level	The current level, optional.
integer	$parent	Unique identifier of the parent folder, if any.

Renvoie:: array Folders in the given folder.

Depuis:: 11.1

Références $GLOBALS, $id, $name, $path, JPath\clean(), et JPATH_ROOT.

Voici le graphe d'appel pour cette fonction :

static JFolder::makeSafe ( $path )

static

Makes path name safe to use.

Paramètres:

string $path The full path to sanitise.

Renvoie:: string The sanitised string.

Depuis:: 11.1

Références $path.

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

static

Moves a folder.

Paramètres:

string	$src	The path to the source folder.
string	$dest	The path to the destination folder.
string	$path	An optional base path to prefix to the file names.
boolean	$use_streams	Optionally use streams.

Renvoie:: mixed Error message on false or boolean true on success.

Depuis:: 11.1

Références $path, JText\_(), JPath\clean(), JClientHelper\getCredentials(), JFTP\getInstance(), JFactory\getStream(), jimport(), JPATH_ROOT, null, et JText\sprintf().

Voici le graphe d'appel pour cette fonction :

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

libraries/joomla/filesystem/folder.php

Fonctions membres publiques statiques

Fonctions membres protégées statiques

Documentation des fonctions membres