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 | Fonctions membres protégées | Attributs protégés | Attributs protégés statiques
Référence de la classe JCacheStorageMemcached
+ Graphe d'héritage de JCacheStorageMemcached:
+ Graphe de collaboration de JCacheStorageMemcached:

Liste de tous les membres

Fonctions membres publiques

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

Fonctions membres publiques statiques

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

Fonctions membres protégées

 getConnection ()
 lockindex ()
 unlockindex ()
- Fonctions membres protégées inherited from JCacheStorage
 _getCacheId ($id, $group)

Attributs protégés

 $_persistent = false
 $_compress = 0
- Attributs protégés inherited from JCacheStorage
 $rawname

Attributs protégés statiques

static $_db = null

Additional Inherited Members

- Attributs publics inherited from JCacheStorage
 $_now
 $_lifetime
 $_locking
 $_language
 $_application
 $_hash

Description détaillée

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

Documentation des constructeurs et destructeur

JCacheStorageMemcached::__construct (   $options = array())

Constructor

Paramètres:
array$optionsOptional parameters.
Depuis:
12.1

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

Définition à la ligne 53 du fichier memcached.php.

{
parent::__construct($options);
if (self::$_db === null)
{
$this->getConnection();
}
}

Documentation des fonctions membres

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

Clean cache for a group given a mode.

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:
12.1

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

Définition à la ligne 280 du fichier memcached.php.

{
if (!$this->lockindex())
{
return false;
}
$index = self::$_db->get($this->_hash . '-index');
if ($index === false)
{
$index = array();
}
$secret = $this->_hash;
foreach ($index as $key => $value)
{
if (strpos($value->name, $secret . '-cache-' . $group . '-') === 0 xor $mode != 'group')
{
self::$_db->delete($value->name, 0);
unset($index[$key]);
}
}
self::$_db->replace($this->_hash . '-index', $index, 0);
$this->unlockindex();
return true;
}
JCacheStorageMemcached::get (   $id,
  $group,
  $checkTime = true 
)

Get cached data from memcached 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:
12.1

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

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

{
$cache_id = $this->_getCacheId($id, $group);
$back = self::$_db->get($cache_id);
return $back;
}
JCacheStorageMemcached::getAll ( )

Get all cached data

Renvoie:
array data
Depuis:
12.1

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

Définition à la ligne 144 du fichier memcached.php.

{
parent::getAll();
$keys = self::$_db->get($this->_hash . '-index');
$secret = $this->_hash;
$data = array();
if (!empty($keys) && is_array($keys))
{
foreach ($keys as $key)
{
if (empty($key))
{
continue;
}
$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;
}
JCacheStorageMemcached::getConnection ( )
protected

Return memcached connection object

Renvoie:
object memcached connection object
Depuis:
12.1
Exceptions:
RuntimeException

Définition à la ligne 70 du fichier memcached.php.

Références JFactory\getConfig(), et JFactory\getSession().

{
if ((extension_loaded('memcached') && class_exists('Memcached')) != true)
{
return false;
}
$config = JFactory::getConfig();
$this->_persistent = $config->get('memcache_persist', true);
$this->_compress = $config->get('memcache_compress', false) == false ? 0 : Memcached::OPT_COMPRESSION;
/*
* This will be an array of loveliness
* @todo: multiple servers
* $servers = (isset($params['servers'])) ? $params['servers'] : array();
*/
$server = array();
$server['host'] = $config->get('memcache_server_host', 'localhost');
$server['port'] = $config->get('memcache_server_port', 11211);
// Create the memcache connection
if ($this->_persistent)
{
$session = JFactory::getSession();
self::$_db = new Memcached($session->getId());
}
else
{
self::$_db = new Memcached;
}
$memcachedtest = self::$_db->addServer($server['host'], $server['port']);
if ($memcachedtest == false)
{
throw new RuntimeException('Could not connect to memcached server', 404);
}
self::$_db->setOption(Memcached::OPT_COMPRESSION, $this->_compress);
// Memcached has no list keys, we do our own accounting, initialise key index
if (self::$_db->get($this->_hash . '-index') === false)
{
$empty = array();
self::$_db->set($this->_hash . '-index', $empty, 0);
}
return;
}

+ Voici le graphe d'appel pour cette fonction :

static JCacheStorageMemcached::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 315 du fichier memcached.php.

Références JFactory\getConfig().

{
if ((extension_loaded('memcached') && class_exists('Memcached')) != true)
{
return false;
}
$config = JFactory::getConfig();
$host = $config->get('memcache_server_host', 'localhost');
$port = $config->get('memcache_server_port', 11211);
$memcached = new Memcached;
$memcachedtest = @$memcached->addServer($host, $port);
if (!$memcachedtest)
{
return false;
}
else
{
return true;
}
}

+ Voici le graphe d'appel pour cette fonction :

JCacheStorageMemcached::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:
boolean True on success, false otherwise.
Depuis:
12.1

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

Définition à la ligne 350 du fichier memcached.php.

{
$returning = new stdClass;
$returning->locklooped = false;
$looptime = $locktime * 10;
$cache_id = $this->_getCacheId($id, $group);
if (!$this->lockindex())
{
return false;
}
$index = self::$_db->get($this->_hash . '-index');
if ($index === false)
{
$index = array();
}
$tmparr = new stdClass;
$tmparr->name = $cache_id;
$tmparr->size = 1;
$index[] = $tmparr;
self::$_db->replace($this->_hash . '-index', $index, 0);
$this->unlockindex();
$data_lock = self::$_db->add($cache_id . '_lock', 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 = self::$_db->add($cache_id . '_lock', 1, $locktime);
$lock_counter++;
}
}
$returning->locked = $data_lock;
return $returning;
}
JCacheStorageMemcached::lockindex ( )
protected

Lock cache index

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

Définition à la ligne 456 du fichier memcached.php.

{
$looptime = 300;
$data_lock = self::$_db->add($this->_hash . '-index_lock', 1, 30);
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)
{
return false;
break;
}
usleep(100);
$data_lock = self::$_db->add($this->_hash . '-index_lock', 1, 30);
$lock_counter++;
}
}
return true;
}
JCacheStorageMemcached::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:
12.1

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

Définition à la ligne 239 du fichier memcached.php.

{
$cache_id = $this->_getCacheId($id, $group);
if (!$this->lockindex())
{
return false;
}
$index = self::$_db->get($this->_hash . '-index');
if ($index === false)
{
$index = array();
}
foreach ($index as $key => $value)
{
if ($value->name == $cache_id)
{
unset($index[$key]);
}
break;
}
self::$_db->replace($this->_hash . '-index', $index, 0);
$this->unlockindex();
return self::$_db->delete($cache_id);
}
JCacheStorageMemcached::store (   $id,
  $group,
  $data 
)

Store the data to memcached 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:
12.1

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

Définition à la ligne 198 du fichier memcached.php.

{
$cache_id = $this->_getCacheId($id, $group);
if (!$this->lockindex())
{
return false;
}
$index = self::$_db->get($this->_hash . '-index');
if ($index === false)
{
$index = array();
}
$tmparr = new stdClass;
$tmparr->name = $cache_id;
$tmparr->size = strlen($data);
$index[] = $tmparr;
self::$_db->replace($this->_hash . '-index', $index, 0);
$this->unlockindex();
// Prevent double writes, write only if it doesn't exist else replace
if (!self::$_db->replace($cache_id, $data, $this->_lifetime))
{
self::$_db->set($cache_id, $data, $this->_lifetime);
}
return true;
}
JCacheStorageMemcached::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:
12.1

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

Définition à la ligne 419 du fichier memcached.php.

{
$cache_id = $this->_getCacheId($id, $group) . '_lock';
if (!$this->lockindex())
{
return false;
}
$index = self::$_db->get($this->_hash . '-index');
if ($index === false)
{
$index = array();
}
foreach ($index as $key => $value)
{
if ($value->name == $cache_id)
{
unset($index[$key]);
}
break;
}
self::$_db->replace($this->_hash . '-index', $index, 0);
$this->unlockindex();
return self::$_db->delete($cache_id);
}
JCacheStorageMemcached::unlockindex ( )
protected

Unlock cache index

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

Définition à la ligne 491 du fichier memcached.php.

{
return self::$_db->delete($this->_hash . '-index_lock');
}

Documentation des données membres

JCacheStorageMemcached::$_compress = 0
protected

Définition à la ligne 44 du fichier memcached.php.

JCacheStorageMemcached::$_db = null
staticprotected

Définition à la ligne 28 du fichier memcached.php.

JCacheStorageMemcached::$_persistent = false
protected

Définition à la ligne 36 du fichier memcached.php.

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