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é
Référence de la classe CacheModelCache
+ Graphe d'héritage de CacheModelCache:

Fonctions membres publiques

 __construct ($config=array())
 
 getData ()
 
 getCache ($clientId=null)
 
 getClient ()
 
 getTotal ()
 
 getPagination ()
 
 clean ($group='')
 
 cleanlist ($array)
 
 purge ()
 

Fonctions membres protégées

 populateState ($ordering='group', $direction='asc')
 
 getStoreId ($id='')
 

Attributs protégés

 $_data = array()
 
 $_total = null
 
 $_pagination = null
 

Description détaillée

Cache Model

Depuis
1.6

Documentation des constructeurs et destructeur

◆ __construct()

__construct (   $config = array())

Constructor.

Paramètres
array$configAn optional associative array of configuration settings.
Depuis
3.5

Références $config.

Documentation des fonctions membres

◆ clean()

clean (   $group = '')

Clean out a cache group as named by param. If no param is passed clean all cache groups.

Paramètres
string$groupCache group name.
Renvoie
boolean True on success, false otherwise

◆ cleanlist()

cleanlist (   $array)

Purge an array of cache groups.

Paramètres
array$arrayArray of cache group names.
Renvoie
array Array with errors, if they exist.

◆ getCache()

getCache (   $clientId = null)

Method to get cache instance.

Renvoie
JCacheController

Références $clientId, $options, JPATH_ADMINISTRATOR, et JPATH_SITE.

◆ getClient()

getClient ( )

Method to get client data.

Renvoie
array
Obsolète:
4.0 No replacement.

◆ getData()

getData ( )

Method to get cache data

Renvoie
array

Références $data, $key, $limit, $listDirn, $listOrder, et $start.

◆ getPagination()

getPagination ( )

Method to get a pagination object for the cache.

Renvoie
JPagination

◆ getStoreId()

getStoreId (   $id = '')
protected

Method to get a store id based on model configuration state.

This is necessary because the model is used by the component and different modules that might need different sets of data or different ordering requirements.

Paramètres
string$idA prefix for the store id.
Renvoie
string A store id.
Depuis
3.5

Références $id.

◆ getTotal()

getTotal ( )

Get the number of current Cache Groups.

Renvoie
integer

◆ populateState()

populateState (   $ordering = 'group',
  $direction = 'asc' 
)
protected

Method to auto-populate the model state.

Note. Calling getState in this method will result in recursion.

Paramètres
string$orderingField for ordering.
string$directionDirection of ordering.
Renvoie
void
Depuis
1.6

Références $clientId, $direction, et $ordering.

◆ purge()

purge ( )

Purge all cache items.

Renvoie
boolean True if successful; false otherwise.

Documentation des champs

◆ $_data

$_data = array()
protected

◆ $_pagination

$_pagination = null
protected

◆ $_total

$_total = null
protected

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