Joomla Platform  13.1
Documentation des API du framework Joomla Platform
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Référence de la classe JCacheStorageXcache
+ Graphe d'héritage de JCacheStorageXcache:
+ Graphe de collaboration de JCacheStorageXcache:

Liste de tous les membres

Fonctions membres publiques

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

Fonctions membres publiques statiques

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

Additional Inherited Members

- Attributs publics inherited from JCacheStorage
 $_now
 $_lifetime
 $_locking
 $_language
 $_application
 $_hash
- Fonctions membres protégées inherited from JCacheStorage
 _getCacheId ($id, $group)
- Attributs protégés inherited from JCacheStorage
 $rawname

Description détaillée

Définition à la ligne 20 du fichier xcache.php.


Documentation des fonctions membres

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

Clean cache for a group given a mode.

This requires the php.ini setting xcache.admin.enable_auth = Off.

Paramètres:
string$groupThe cache data group
string$modeThe 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.

Définition à la ligne 146 du fichier xcache.php.

{
$allinfo = xcache_list(XC_TYPE_VAR, 0);
$keys = $allinfo['cache_list'];
$secret = $this->_hash;
foreach ($keys as $key)
{
if (strpos($key['name'], $secret . '-cache-' . $group . '-') === 0 xor $mode != 'group')
{
xcache_unset($key['name']);
}
}
return true;
}
JCacheStorageXcache::gc ( )

Garbage collect expired cache data

This is a dummy, since xcache has built in garbage collector, turn it on in php.ini by changing default xcache.gc_interval setting from 0 to 3600 (=1 hour)

Renvoie:
boolean True on success, false otherwise.
Depuis:
11.1

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

Définition à la ligne 173 du fichier xcache.php.

{
/*
$now = time();
$cachecount = xcache_count(XC_TYPE_VAR);
for ($i = 0; $i < $cachecount; $i ++) {
$allinfo = xcache_list(XC_TYPE_VAR, $i);
$keys = $allinfo ['cache_list'];
foreach($keys as $key) {
if (strstr($key['name'], $this->_hash)) {
if (($key['ctime'] + $this->_lifetime ) < $this->_now) xcache_unset($key['name']);
}
}
}
*/
return true;
}
JCacheStorageXcache::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 string
Depuis:
11.1

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

Définition à la ligne 33 du fichier xcache.php.

{
$cache_id = $this->_getCacheId($id, $group);
$cache_content = xcache_get($cache_id);
if ($cache_content === null)
{
return false;
}
return $cache_content;
}
JCacheStorageXcache::getAll ( )

Get all cached data

This requires the php.ini setting xcache.admin.enable_auth = Off.

Renvoie:
array data
Depuis:
11.1

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

Définition à la ligne 55 du fichier xcache.php.

{
$allinfo = xcache_list(XC_TYPE_VAR, 0);
$keys = $allinfo['cache_list'];
$secret = $this->_hash;
$data = array();
foreach ($keys as $key)
{
$namearr = explode('-', $key['name']);
if ($namearr !== false && $namearr[0] == $secret && $namearr[1] == 'cache')
{
$group = $namearr[2];
if (!isset($data[$group]))
{
$item = new JCacheStorageHelper($group);
}
else
{
$item = $data[$group];
}
$item->updateSize($key['size'] / 1024);
$data[$group] = $item;
}
}
return $data;
}
static JCacheStorageXcache::isSupported ( )
static

Test to see if the cache storage is available.

Renvoie:
boolean True on success, false otherwise.
Depuis:
12.1

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

Définition à la ligne 205 du fichier xcache.php.

{
return (extension_loaded('xcache'));
}
JCacheStorageXcache::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 True on success, false otherwise
Depuis:
11.1

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

Définition à la ligne 120 du fichier xcache.php.

{
$cache_id = $this->_getCacheId($id, $group);
if (!xcache_isset($cache_id))
{
return true;
}
return xcache_unset($cache_id);
}
JCacheStorageXcache::store (   $id,
  $group,
  $data 
)

Store the data 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 True on success, false otherwise
Depuis:
11.1

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

Définition à la ligne 103 du fichier xcache.php.

{
$cache_id = $this->_getCacheId($id, $group);
$store = xcache_set($cache_id, $data, $this->_lifetime);
return $store;
}

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