Joomla CMS  3.10.11 (avec JPlatform 13.1 inclus)
Documentation des API du CMS Joomla en version 3.10.11 et du framework Joomla Platform intégré
Tout Structures de données Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe CacheStorage
+ Graphe d'héritage de CacheStorage:

Fonctions membres publiques

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

Fonctions membres publiques statiques

static isSupported ()
 
static test ()
 
static addIncludePath ($path='')
 

Champs de données

 $_now
 
 $_lifetime
 
 $_locking
 
 $_language
 
 $_application
 
 $_hash
 

Fonctions membres protégées

 _getCacheId ($id, $group)
 

Attributs protégés

 $rawname
 

Description détaillée

Abstract cache storage handler

Depuis
1.7.0
Note
As of 4.0 this class will be abstract

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $options = array())

Constructor

Paramètres
array$optionsOptional parameters
Depuis
1.7.0

Références $config, $options, et JPATH_CONFIGURATION.

Documentation des fonctions membres

◆ _getCacheId()

_getCacheId (   $id,
  $group 
)
protected

Get a cache ID string from an ID/group pair

Paramètres
string$idThe cache data ID
string$groupThe cache data group
Renvoie
string
Depuis
1.7.0

Références $id, $name, et Cache\getPlatformPrefix().

◆ addIncludePath()

static addIncludePath (   $path = '')
static

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

Paramètres
array | string$pathA path to search.
Renvoie
array An array with directory elements
Depuis
1.7.0

Références $path, et JLoader\import().

◆ clean()

clean (   $group,
  $mode = null 
)

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$groupThe cache data group
string$modeThe mode for cleaning cache [group|notgroup]
Renvoie
boolean
Depuis
1.7.0

◆ contains()

contains (   $id,
  $group 
)

Check if the cache contains data stored by ID and group

Paramètres
string$idThe cache data ID
string$groupThe cache data group
Renvoie
boolean
Depuis
3.7.0

◆ flush()

flush ( )

Flush all existing items in storage.

Renvoie
boolean
Depuis
3.6.3

◆ gc()

gc ( )

Garbage collect expired cache data

Renvoie
boolean
Depuis
1.7.0

◆ get()

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

Get cached data by ID and group

Paramètres
string$idThe cache data ID
string$groupThe cache data group
boolean$checkTimeTrue to verify cache time expiration threshold
Renvoie
mixed Boolean false on failure or a cached data object
Depuis
1.7.0

◆ getAll()

getAll ( )

Get all cached data

Renvoie
mixed Boolean false on failure or a cached data object
Depuis
1.7.0

◆ isSupported()

static isSupported ( )
static

Test to see if the storage handler is available.

Renvoie
boolean
Depuis
3.0.0

◆ lock()

lock (   $id,
  $group,
  $locktime 
)

Lock cached item

Paramètres
string$idThe cache data ID
string$groupThe cache data group
integer$locktimeCached item max lock time
Renvoie
mixed Boolean false if locking failed or an object containing properties lock and locklooped
Depuis
1.7.0

◆ remove()

remove (   $id,
  $group 
)

Remove a cached data entry by ID and group

Paramètres
string$idThe cache data ID
string$groupThe cache data group
Renvoie
boolean
Depuis
1.7.0

◆ store()

store (   $id,
  $group,
  $data 
)

Store the data to cache by ID and group

Paramètres
string$idThe cache data ID
string$groupThe cache data group
string$dataThe data to store in cache
Renvoie
boolean
Depuis
1.7.0

◆ test()

static test ( )
static

Test to see if the storage handler is available.

Renvoie
boolean
Depuis
1.7.0
Obsolète:
4.0

Références Log\add(), et Log\WARNING.

◆ unlock()

unlock (   $id,
  $group = null 
)

Unlock cached item

Paramètres
string$idThe cache data ID
string$groupThe cache data group
Renvoie
boolean
Depuis
1.7.0

Documentation des champs

◆ $_application

$_application

◆ $_hash

$_hash

◆ $_language

$_language

◆ $_lifetime

$_lifetime

◆ $_locking

$_locking

◆ $_now

$_now

◆ $rawname

$rawname
protected

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