Fonctions membres publiques

copy ($src, $dest, $path= '', $force=false)
create ($path= '', $mode=0755)
delete ($path)
move ($src, $dest, $path= '')
exists ($path)
files ($path, $filter= '.', $recurse=false, $fullpath=false, $exclude=array('.svn', 'CVS'))
folders ($path, $filter= '.', $recurse=false, $fullpath=false, $exclude=array('.svn', 'CVS'))
listFolderTree ($path, $filter, $maxLevel=3, $level=0, $parent=0)
makeSafe ($path)

Documentation des fonctions membres

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

Copy a folder.

Paramètres:

string	The path to the source folder.
string	The path to the destination folder.
string	An optional base path to prefix to the file names.
boolean	Optionally force folder/file overwrites.

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

Depuis:: 1.5

Références $file, $path, JText::_(), JPath::clean(), create(), exists(), JClientHelper::getCredentials(), JFTP::getInstance(), jimport(), et JError::raiseError().

Référencé par JInstaller::copyFiles().

Voici le graphe d'appel pour cette fonction :

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

Create a folder -- and all necessary parent folders.

Paramètres:

string	A path to create from the base path.
int	Directory permissions to set for folders created.

Renvoie:: boolean True if successful.

Depuis:: 1.5

Références $path, JText::_(), JPath::clean(), exists(), JClientHelper::getCredentials(), JFTP::getInstance(), jimport(), et JError::raiseWarning().

Référencé par JArchiveZip::_extract(), JArchiveZip::_extractNative(), JInstallerLanguage::_install(), JLog::_openLog(), copy(), JFile::copy(), MediaControllerFolder::create(), JArchiveTar::extract(), JArchive::extract(), JInstallerTemplate::install(), JInstallerPlugin::install(), JInstallerModule::install(), JInstallerComponent::install(), mosMakePath(), plgAuthenticationOpenID::onAuthenticate(), JInstaller::parseFiles(), JInstaller::parseLanguages(), JInstaller::parseMedia(), PclZip::privDirCheck(), JFile::upload(), et JFile::write().

Voici le graphe d'appel pour cette fonction :

JFolder::delete ( $ path )

Delete a folder.

Paramètres:

string The path to the folder to delete.

Renvoie:: boolean True on success.

Depuis:: 1.5

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

Référencé par JInstaller::abort(), JInstallationModel::checkUpload(), JCacheStorageFile::clean(), JInstallerHelper::cleanupInstall(), MediaControllerFolder::delete(), MediaControllerFile::delete(), JInstaller::removeFiles(), JInstallerTemplate::uninstall(), JInstallerPlugin::uninstall(), JInstallerModule::uninstall(), JInstallerLanguage::uninstall(), JInstallerComponent::uninstall(), et JInstallationHelper::uploadSql().

Voici le graphe d'appel pour cette fonction :

JFolder::exists ( $ path )

Wrapper for the standard file_exists function

Paramètres:

string Folder name relative to installation dir

Renvoie:: boolean True if path is a folder

Depuis:: 1.5

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

Référencé par iLink::_getViews(), InstallerModelComponents::_loadItems(), copy(), create(), JLanguage::exists(), getHelpTOC(), HTML_admin_misc::help(), JInstaller::install(), move(), plgAuthenticationOpenID::onAuthenticate(), JInstaller::parseLanguages(), JInstallationHelper::postMigrate(), JInstaller::removeFiles(), JInstallerTemplate::uninstall(), JInstallerLanguage::uninstall(), JInstallerHelper::unpack(), et JInstaller::update().

Voici le graphe d'appel pour cette fonction :

JFolder::files	(	$	path,
		$	filter = `'.'`,
		$	recurse = `false`,
		$	fullpath = `false`,
		$	exclude = `array('.svn', 'CVS')`
	)

Utility function to read the files in a folder.

Paramètres:

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

Renvoie:: array Files in the given folder.

Depuis:: 1.5

Références $file, $path, JText::_(), JPath::clean(), et JError::raiseWarning().

Référencé par JInstaller::_findManifest(), iLink::_getLayouts(), InstallerModelTemplates::_loadItems(), InstallerModelLanguages::_loadItems(), InstallerModelComponents::_loadItems(), CacheData::_parse(), JLanguage::_parseXMLLanguageFiles(), TemplatesController::chooseTemplateCSS(), delete(), MediaControllerFolder::delete(), MediaControllerFile::delete(), JInstallerHelper::detectType(), JElementFilelist::fetchElement(), JCacheStorageFile::gc(), JDatabase::getConnectors(), getHelpTOC(), MediaModelList::getList(), JSession::getStores(), JCache::getStores(), JHTMLList::images(), mosReadDirectory(), mosAdminMenus::ReadImages(), JInstallerPlugin::uninstall(), et JInstallerHelper::unpack().

Voici le graphe d'appel pour cette fonction :

JFolder::folders	(	$	path,
		$	filter = `'.'`,
		$	recurse = `false`,
		$	fullpath = `false`,
		$	exclude = `array('.svn', 'CVS')`
	)

Utility function to read the folders in a folder.

Paramètres:

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

Renvoie:: array Folders in the given folder.

Depuis:: 1.5

Références $file, $path, JText::_(), JPath::clean(), et JError::raiseWarning().

Référencé par iLink::_getViews(), InstallerModelTemplates::_loadItems(), InstallerModelLanguages::_loadItems(), CacheData::_parse(), JLanguage::_parseLanguageFiles(), JCacheStorageFile::clean(), delete(), JElementFolderlist::fetchElement(), MediaModelManager::getFolderList(), MediaModelManager::getFolderTree(), MediaModelList::getList(), JInstallation::getLocaliseAdmin(), listFolderTree(), mosReadDirectory(), TemplatesHelper::parseXMLTemplateFiles(), et JInstallerHelper::unpack().

Voici le graphe d'appel pour cette fonction :

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

Lists folder in format suitable for tree display.

public

Paramètres:

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