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

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 ()
 lock ($id, $group, $locktime)
 unlock ($id, $group=null)
- Fonctions membres publiques inherited from JCacheStorage
 __construct ($options=array())

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 apc.php.

Documentation des fonctions membres

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

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

Définition à la ligne 130 du fichier apc.php.

{
$allinfo = apc_cache_info('user');
$keys = $allinfo['cache_list'];
$secret = $this->_hash;
foreach ($keys as $key)
{
if (strpos($key['info'], $secret . '-cache-' . $group . '-') === 0 xor $mode != 'group')
{
apc_delete($key['info']);
}
}
return true;
}
JCacheStorageApc::gc ( )

Force garbage collect expired cache data as items are removed only on fetch!

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

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

Définition à la ligne 154 du fichier apc.php.

{
$allinfo = apc_cache_info('user');
$keys = $allinfo['cache_list'];
$secret = $this->_hash;
foreach ($keys as $key)
{
if (strpos($key['info'], $secret . '-cache-'))
{
apc_fetch($key['info']);
}
}
}
JCacheStorageApc::get (   $id,
  $group,
  $checkTime = true 
)

Get cached data from APC 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 apc.php.

{
$cache_id = $this->_getCacheId($id, $group);
return apc_fetch($cache_id);
}
JCacheStorageApc::getAll ( )

Get all cached data

Renvoie:
array data
Depuis:
11.1

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

Définition à la ligne 46 du fichier apc.php.

{
parent::getAll();
$allinfo = apc_cache_info('user');
$keys = $allinfo['cache_list'];
$secret = $this->_hash;
$data = array();
foreach ($keys as $key)
{
$name = $key['info'];
$namearr = explode('-', $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['mem_size'] / 1024);
$data[$group] = $item;
}
}
return $data;
}
static JCacheStorageApc::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 176 du fichier apc.php.

{
return extension_loaded('apc');
}
JCacheStorageApc::lock (   $id,
  $group,
  $locktime 
)

Lock cached item - override parent as this is more efficient

Paramètres:
string$idThe cache data id
string$groupThe cache data group
integer$locktimeCached item max lock time
Renvoie:
object Properties are lock and locklooped
Depuis:
11.1

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

Définition à la ligne 192 du fichier apc.php.

{
$returning = new stdClass;
$returning->locklooped = false;
$looptime = $locktime * 10;
$cache_id = $this->_getCacheId($id, $group) . '_lock';
$data_lock = apc_add($cache_id, 1, $locktime);
if ($data_lock === false)
{
$lock_counter = 0;
// Loop until you find that the lock has been released.
// That implies that data get from other thread has finished
while ($data_lock === false)
{
if ($lock_counter > $looptime)
{
$returning->locked = false;
$returning->locklooped = true;
break;
}
usleep(100);
$data_lock = apc_add($cache_id, 1, $locktime);
$lock_counter++;
}
}
$returning->locked = $data_lock;
return $returning;
}
JCacheStorageApc::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 111 du fichier apc.php.

{
$cache_id = $this->_getCacheId($id, $group);
return apc_delete($cache_id);
}
JCacheStorageApc::store (   $id,
  $group,
  $data 
)

Store the data to APC 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 95 du fichier apc.php.

{
$cache_id = $this->_getCacheId($id, $group);
return apc_store($cache_id, $data, $this->_lifetime);
}
JCacheStorageApc::unlock (   $id,
  $group = null 
)

Unlock cached item - override parent for cacheid compatibility with lock

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 241 du fichier apc.php.

{
$cache_id = $this->_getCacheId($id, $group) . '_lock';
$unlock = apc_delete($cache_id);
return $unlock;
}
La documentation de cette classe a été générée à partir du fichier suivant :