Fonctions membres publiques
	__construct ($options)

	setCaching ($enabled)

	getCaching ()

	setLifeTime ($lt)

	contains ($id, $group=null)

	get ($id, $group=null)

	getAll ()

	store ($data, $id, $group=null)

	remove ($id, $group=null)

	clean ($group=null, $mode='group')

	gc ()

	lock ($id, $group=null, $locktime=null)

	unlock ($id, $group=null)

&	_getStorage ()

Fonctions membres publiques statiques
static	getInstance ($type='output', $options=array())

static	getStores ()

static	getWorkarounds ($data, $options=array())

static	setWorkarounds ($data, $options=[])

static	makeId ()

static	getPlatformPrefix ()

static	addIncludePath ($path='')

Champs de données
	$_options

Attributs publics statiques
static	$_handler = array()

Description détaillée

Joomla! Cache base object

Depuis: 1.7.0

Documentation des constructeurs et destructeur

◆ __construct()

__construct ( $options )

Constructor

Paramètres

array $options Cache options

Depuis: 1.7.0

Références $app, $option, $options, $value, Factory\getApplication(), JPATH_CACHE, et Cache\setCaching().

Documentation des fonctions membres

◆ _getStorage()

& _getStorage ( )

Get the cache storage handler

Renvoie: CacheStorage

Depuis: 1.7.0

Références $hash.

Référencé par Cache\clean(), Cache\contains(), Cache\gc(), Cache\get(), Cache\getAll(), Cache\lock(), Cache\remove(), Cache\store(), et Cache\unlock().

◆ addIncludePath()

static addIncludePath ( $path = '' )

static

Add a directory where Cache should search for handlers. You may either pass a string or an array of directories.

Paramètres

array | string $path A path to search.

Renvoie: array An array with directory elements

Depuis: 1.7.0

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

◆ clean()

clean	(	$group = `null`,
		$mode = `'group'`
	)

Clean cache for a group given a mode.

group mode : cleans all cache in the group notgroup mode : cleans all cache not in the group

Paramètres

string	$group	The cache data group
string	$mode	The mode for cleaning cache [group\|notgroup]

Renvoie: boolean True on success, false otherwise

Depuis: 1.7.0

Références $mode, Cache\_getStorage(), et Cache\getCaching().

◆ contains()

contains	(	$id,
		$group = `null`
	)

Check if the cache contains data stored by ID and group

Paramètres

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

Renvoie: boolean

Depuis: 3.7.0

Références $id, Cache\_getStorage(), et Cache\getCaching().

◆ gc()

gc ( )

Garbage collect expired cache data

Renvoie: boolean

Depuis: 1.7.0

Références Cache\_getStorage(), et Cache\getCaching().

◆ get()

get	(	$id,
		$group = `null`
	)

Get cached data by ID and group

Paramètres

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

Renvoie: mixed Boolean false on failure or a cached data object

Depuis: 1.7.0

Références $id, Cache\_getStorage(), et Cache\getCaching().

◆ getAll()

getAll ( )

Get a list of all cached data

Renvoie: mixed Boolean false on failure or an object with a list of cache groups and data

Depuis: 1.7.0

Références Cache\_getStorage(), et Cache\getCaching().

◆ getCaching()

getCaching ( )

Get caching state

Renvoie: boolean

Depuis: 1.7.0

Référencé par Cache\clean(), Cache\contains(), Cache\gc(), Cache\get(), Cache\getAll(), Cache\lock(), Cache\remove(), Cache\store(), et Cache\unlock().

◆ getInstance()

static getInstance	(	$type = `'output'`,
		$options = `array()`
	)

static

Returns a reference to a cache adapter object, always creating it

Paramètres

string	$type	The cache object type to instantiate
array	$options	The array of options

Renvoie: CacheController

Depuis: 1.7.0

Obsolète:: 5.0 Use the cache controller factory instead

Références $options, $type, class, et Factory\getContainer().

Référencé par CacheModel\getCache().

◆ getPlatformPrefix()

static getPlatformPrefix ( )

static

Set a prefix cache key if device calls for separate caching

Renvoie: string

Depuis: 3.5

Références Factory\getApplication().

Référencé par MemcachedStorage\_getCacheId(), et CacheStorage\_getCacheId().

◆ getStores()

static getStores ( )

static

Get the storage handlers

Renvoie: array

Depuis: 1.7.0

$file

Références $class, et __DIR__.

Référencé par CachehandlerField\getOptions().

◆ getWorkarounds()

static getWorkarounds	(	$data,
		$options = `array()`
	)

static

Perform workarounds on retrieved cached data

Paramètres

array	$data	Cached data
array	$options	Array of options

Renvoie: string Body of cached data

Depuis: 1.7.0

Références $app, $data, $document, $header, $name, $options, elseif, Factory\getApplication(), Factory\getDocument(), Session\getFormToken(), et null.

Référencé par ViewController\get(), et PageController\get().

◆ lock()

lock	(	$id,
		$group = `null`,
		$locktime = `null`
	)

Set lock flag on cached item

Paramètres

string	$id	The cache data ID
string	$group	The cache data group
string	$locktime	The default locktime for locking the cache.

Renvoie: Object with properties of lock and locklooped

Depuis: 1.7.0

Références $id, Joomla\Database\Query\$returning, Cache\_getStorage(), et Cache\getCaching().

◆ makeId()

static makeId ( )

static

Create a safe ID for cached data from URL parameters

Renvoie: string MD5 encoded cache ID

Depuis: 1.7.0

Références $app, $key, $type, $value, Factory\getApplication(), et null.

Référencé par ViewController\_makeId(), et PageController\_makeId().

◆ remove()

remove	(	$id,
		$group = `null`
	)

Remove a cached data entry by ID and group

Paramètres

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

Renvoie: boolean

Depuis: 1.7.0

Références $id, Cache\_getStorage(), et Cache\getCaching().

◆ setCaching()

setCaching ( $enabled )

Set caching enabled state

Paramètres

boolean $enabled True to enable caching

Renvoie: void

Depuis: 1.7.0

Références $enabled.

Référencé par Cache\__construct().

◆ setLifeTime()

setLifeTime ( $lt )

Set cache lifetime

Paramètres

integer $lt Cache lifetime

Renvoie: void

Depuis: 1.7.0

◆ setWorkarounds()

static setWorkarounds	(	$data,
		$options = `[]`
	)

static

Create workarounds for data to be cached

Paramètres

string	$data	Cached data
array	$options	Array of options

Renvoie: array Data to be cached

Depuis: 1.7.0

Références $app, $data, $document, $key, $options, Factory\getApplication(), et Factory\getDocument().

Référencé par ViewController\get(), et PageController\store().

◆ store()

store	(	$data,
		$id,
		$group = `null`
	)

Store the cached data by ID and group

Paramètres

mixed	$data	The data to store
string	$id	The cache data ID
string	$group	The cache data group

Renvoie: boolean

Depuis: 1.7.0

Références $data, $id, Cache\_getStorage(), et Cache\getCaching().

◆ unlock()

unlock	(	$id,
		$group = `null`
	)

Unset lock flag on cached item

Paramètres

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

Renvoie: boolean

Depuis: 1.7.0

Références $id, Cache\_getStorage(), et Cache\getCaching().

Documentation des champs

◆ $_handler

$_handler = array()

static

◆ $_options

$_options

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

libraries/src/Cache/Cache.php

Fonctions membres publiques

Fonctions membres publiques statiques

Champs de données

Attributs publics statiques

Description détaillée

Documentation des constructeurs et destructeur

◆ __construct()

Documentation des fonctions membres

◆ _getStorage()

◆ addIncludePath()

◆ clean()

◆ contains()

◆ gc()

◆ get()

◆ getAll()

◆ getCaching()

◆ getInstance()

◆ getPlatformPrefix()

◆ getStores()

◆ getWorkarounds()

◆ lock()

◆ makeId()

◆ remove()

◆ setCaching()

◆ setLifeTime()

◆ setWorkarounds()

◆ store()

◆ unlock()

Documentation des champs

◆ $_handler

◆ $_options