Référence de la classe JCacheStorageFile

Graphe d'héritage de JCacheStorageFile:

Graphe de collaboration de JCacheStorageFile:

Liste de tous les membres

Fonctions membres publiques
	__construct ($options=array())
	get ($id, $group, $checkTime=true)
	getAll ()
	store ($id, $group, $data)
	remove ($id, $group)
	clean ($group, $mode=null)
	gc ()
	lock ($id, $group, $locktime)
	unlock ($id, $group=null)

Fonctions membres publiques statiques
static	test ()
Fonctions membres publiques statiques inherited from JCacheStorage
static	getInstance ($handler=null, $options=array())
static	addIncludePath ($path= '')

Fonctions membres protégées
	_checkExpire ($id, $group)
	_getFilePath ($id, $group)
	_deleteFolder ($path)
	_cleanPath ($path, $ds=DIRECTORY_SEPARATOR)
	_filesInFolder ($path, $filter= '.', $recurse=false, $fullpath=false, $exclude=array('.svn', 'CVS', '.DS_Store', '__MACOSX'), $excludefilter=array('^\..*', '.*~'))
	_folders ($path, $filter= '.', $recurse=false, $fullpath=false, $exclude=array('.svn', 'CVS', '.DS_Store', '__MACOSX'), $excludefilter=array('^\..*'))
Fonctions membres protégées inherited from JCacheStorage
	_getCacheId ($id, $group)

Attributs protégés
	$_root
Attributs protégés inherited from JCacheStorage
	$rawname

Additional Inherited Members
Attributs publics inherited from JCacheStorage
	$_now
	$_lifetime
	$_locking
	$_language
	$_application
	$_hash

---

Documentation des constructeurs et destructeur

JCacheStorageFile::__construct

(

$options = array()

)

Constructor

Paramètres:

array

$options

Optional parameters

Depuis:

11.1

Réimplémentée à partir de JCacheStorage.

Références $options.

---

Documentation des fonctions membres

JCacheStorageFile::_checkExpire (   $id,   $group  )

protected

Check to make sure cache is still valid, if not, delete it.

Paramètres:

string	$id	Cache key to expire.
string	$group	The cache data group.

Renvoie:

boolean False if not valid

Depuis:

11.1

Références $id, et $path.

JCacheStorageFile::_cleanPath (   $path,   $ds = DIRECTORY_SEPARATOR  )

protected

Function to strip additional / or \ in a path name

Paramètres:

string	$path	The path to clean
string	$ds	Directory separator (optional)

Renvoie:

string The cleaned path

Depuis:

11.1

Références $path.

JCacheStorageFile::_deleteFolder (   $path )

protected

Quickly delete a folder of files

Paramètres:

string

$path

The path to the folder to delete.

Renvoie:

boolean True on success.

Depuis:

11.1

Références $file, $files, $folder, $path, JText\_(), elseif, JError\raiseWarning(), et JText\sprintf().

Voici le graphe d'appel pour cette fonction :

JCacheStorageFile::_filesInFolder (   $path,   $filter = '.',   $recurse = false,   $fullpath = false,   $exclude = array('.svn', 'CVS', '.DS_Store', '__MACOSX'),   $excludefilter = array('^\..*', '.*~')  )

protected

Utility function to quickly 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	$fullpath	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 folder names to exclude

Renvoie:

array Files in the given folder.

Depuis:

11.1

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

Voici le graphe d'appel pour cette fonction :

JCacheStorageFile::_folders (   $path,   $filter = '.',   $recurse = false,   $fullpath = false,   $exclude = array('.svn', 'CVS', '.DS_Store', '__MACOSX'),   $excludefilter = array('^\..*')  )

protected

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	$fullpath	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 $file, $path, JError\raiseWarning(), et JText\sprintf().

Voici le graphe d'appel pour cette fonction :

JCacheStorageFile::_getFilePath (   $id,   $group  )

protected

Get a cache file path from an id/group pair

Paramètres:

string	$id	The cache data id
string	$group	The cache data group

Renvoie:

string The cache file path

Depuis:

11.1

Références $id, et $name.

JCacheStorageFile::clean	(		$group,
			$mode = null
	)

Clean cache for a group given a mode.

Paramètres:

string	$group	The cache data group
string	$mode	The mode for cleaning cache [group|notgroup] group mode : cleans all cache in the group notgroup mode : cleans all cache not in the group

Renvoie:

boolean True on success, false otherwise

Depuis:

11.1

Réimplémentée à partir de JCacheStorage.

Références $folder, $i, $mode, $n, et $return.

JCacheStorageFile::gc

(

)

Garbage collect expired cache data

Renvoie:

boolean True on success, false otherwise.

Depuis:

11.1

Réimplémentée à partir de JCacheStorage.

Références $file, et $files.

JCacheStorageFile::get	(		$id,
			$group,
			$checkTime = true
	)

Get cached data from a file by id and group

Paramètres:

string	$id	The cache data id
string	$group	The cache data group
boolean	$checkTime	True to verify cache time expiration threshold

Renvoie:

mixed Boolean false on failure or a cached data string

Depuis:

11.1

Réimplémentée à partir de JCacheStorage.

Références $data, $id, et $path.

JCacheStorageFile::getAll

(

)

Get all cached data

Renvoie:

array The cached data

Depuis:

11.1

Réimplémentée à partir de JCacheStorage.

Références $data, $file, $files, $folder, $item, et $path.

JCacheStorageFile::lock	(		$id,
			$group,
			$locktime
	)

Lock cached item

Paramètres:

string	$id	The cache data id
string	$group	The cache data group
integer	$locktime	Cached item max lock time

Renvoie:

boolean True on success, false otherwise.

Depuis:

11.1

Réimplémentée à partir de JCacheStorage.

Références $id, et $path.

JCacheStorageFile::remove	(		$id,
			$group
	)

Remove a cached data file by id and group

Paramètres:

string	$id	The cache data id
string	$group	The cache data group

Renvoie:

boolean True on success, false otherwise

Depuis:

11.1

Réimplémentée à partir de JCacheStorage.

Références $id, et $path.

JCacheStorageFile::store	(		$id,
			$group,
			$data
	)

Store the data to a file by id and group

Paramètres:

string	$id	The cache data id
string	$group	The cache data group
string	$data	The data to store in cache

Renvoie:

boolean True on success, false otherwise

Depuis:

11.1

Réimplémentée à partir de JCacheStorage.

Références $data, $id, et $path.

static JCacheStorageFile::test ( )

static

Test to see if the cache storage is available.

Renvoie:

boolean True on success, false otherwise.

Depuis:

11.1

Réimplémentée à partir de JCacheStorage.

Références JFactory\getConfig(), et JPATH_CACHE.

Voici le graphe d'appel pour cette fonction :

JCacheStorageFile::unlock	(		$id,
			$group = null
	)

Unlock cached item

Paramètres:

string	$id	The cache data id
string	$group	The cache data group

Renvoie:

boolean True on success, false otherwise.

Depuis:

11.1

Réimplémentée à partir de JCacheStorage.

Références $id, et $path.

---

Documentation des données membres

JCacheStorageFile::$_root

protected

---

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

• libraries/joomla/cache/storage/file.php