Joomla CMS  4.2.2
Documentation des API du CMS Joomla en version 4.2.2
Référence de la classe ApcuStorage
+ Graphe d'héritage de ApcuStorage:

Fonctions membres publiques

 contains ($id, $group)
 
 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 hérités de CacheStorage
 __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 ()
 
- Fonctions membres publiques statiques hérités de CacheStorage
static isSupported ()
 
static addIncludePath ($path='')
 

Membres hérités additionnels

- Champs de données hérités de CacheStorage
 $_now
 
 $_lifetime
 
 $_locking
 
 $_language
 
 $_application
 
 $_hash
 
- Fonctions membres protégées hérités de CacheStorage
 _getCacheId ($id, $group)
 
- Attributs protégés hérités de CacheStorage
 $rawname
 

Description détaillée

APCu cache storage handler

3.5

Documentation des fonctions membres

◆ 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
3.5

Références $key, $mode, et elseif.

◆ 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

Références $id.

◆ gc()

gc ( )

Garbage collect expired cache data

Renvoie
boolean
Depuis
3.5

Références $key, et elseif.

◆ 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
3.5

Références $id.

◆ getAll()

getAll ( )

Get all cached data

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

Références $data, $item, $key, $name, et elseif.

◆ isSupported()

static isSupported ( )
static

Test to see if the storage handler is available.

Renvoie
boolean
Depuis
3.5

◆ 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
3.5

Références $id, et Joomla\Database\Query\$returning.

◆ 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
3.5

Références $id.

◆ 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
3.5

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

◆ unlock()

unlock (   $id,
  $group = null 
)

Unlock cached item

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

Références $id.


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