Référence de la classe JCacheStorage

Graphe d'héritage de JCacheStorage:

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)
	gc ()
	lock ($id, $group, $locktime)
	unlock ($id, $group=null)

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

Attributs publics
	$_now
	$_lifetime
	$_locking
	$_language
	$_application
	$_hash

Fonctions membres protégées
	_getCacheId ($id, $group)

Attributs protégés
	$rawname

---

Description détaillée

Définition à la ligne 19 du fichier storage.php.

---

Documentation des constructeurs et destructeur

JCacheStorage::__construct

(

$options = array()

)

Constructor

Paramètres:

array

$options

Optional parameters

Depuis:

11.1

Réimplémentée dans JCacheStorageMemcache, JCacheStorageMemcached, JCacheStorageCachelite, JCacheStorageFile, et JCacheStorageWincache.

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

Références JFactory\getConfig().

        {
                $config = JFactory::getConfig();
                $this->_hash = md5($config->get('secret'));
                $this->_application = (isset($options['application'])) ? $options['application'] : null;
                $this->_language = (isset($options['language'])) ? $options['language'] : 'en-GB';
                $this->_locking = (isset($options['locking'])) ? $options['locking'] : true;
                $this->_lifetime = (isset($options['lifetime'])) ? $options['lifetime'] * 60 : $config->get('cachetime') * 60;
                $this->_now = (isset($options['now'])) ? $options['now'] : time();

                // Set time threshold value.  If the lifetime is not set, default to 60 (0 is BAD)
                // _threshold is now available ONLY as a legacy (it's deprecated).  It's no longer used in the core.
                if (empty($this->_lifetime))
                {
                        $this->_threshold = $this->_now - 60;
                        $this->_lifetime = 60;
                }
                else
                {
                        $this->_threshold = $this->_now - $this->_lifetime;
                }

        }

Voici le graphe d'appel pour cette fonction :

---

Documentation des fonctions membres

JCacheStorage::_getCacheId (   $id,   $group  )

protected

Get a cache_id string from an id/group pair

Paramètres:

string	$id	The cache data id
string	$group	The cache data group

Renvoie:

string The cache_id string

Depuis:

11.1

Définition à la ligne 312 du fichier storage.php.

        {
                $name = md5($this->_application . '-' . $id . '-' . $this->_language);
                $this->rawname = $this->_hash . '-' . $name;
                return $this->_hash . '-cache-' . $group . '-' . $name;
        }

static JCacheStorage::addIncludePath (   $path = '' )

static

Add a directory where JCacheStorage should search for handlers. You may either pass a string or an array of directories.

Paramètres:

string

$path

A path to search.

Renvoie:

array An array with directory elements

Depuis:

11.1

Définition à la ligne 329 du fichier storage.php.

Références JPath\clean(), et jimport().

        {
                static $paths;

                if (!isset($paths))
                {
                        $paths = array();
                }

                if (!empty($path) && !in_array($path, $paths))
                {
                        jimport('joomla.filesystem.path');
                        array_unshift($paths, JPath::clean($path));
                }

                return $paths;
        }

Voici le graphe d'appel pour cette fonction :

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

Clean cache for a group given a mode.

Paramètres:

string	$group	The cache data group
string	$mode	The 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 dans JCacheStorageMemcached, JCacheStorageMemcache, JCacheStorageCachelite, JCacheStorageFile, JCacheStorageXcache, JCacheStorageWincache, et JCacheStorageApc.

Définition à la ligne 227 du fichier storage.php.

        {
                return true;
        }

JCacheStorage::gc

(

)

Garbage collect expired cache data

Renvoie:

boolean True on success, false otherwise.

Depuis:

11.1

Réimplémentée dans JCacheStorageCachelite, JCacheStorageFile, JCacheStorageXcache, JCacheStorageWincache, et JCacheStorageApc.

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

        {
                return true;
        }

JCacheStorage::get	(		$id,
			$group,
			$checkTime = true
	)

Get cached data by id and group

Paramètres:

string	$id	The cache data id
string	$group	The cache data group
boolean	$checkTime	True to verify cache time expiration threshold

Renvoie:

mixed Boolean false on failure or a cached data object

Depuis:

11.1

Réimplémentée dans JCacheStorageMemcached, JCacheStorageMemcache, JCacheStorageCachelite, JCacheStorageFile, JCacheStorageWincache, JCacheStorageApc, et JCacheStorageXcache.

Définition à la ligne 162 du fichier storage.php.

        {
                return false;
        }

JCacheStorage::getAll

(

)

Get all cached data

Renvoie:

mixed Boolean false on failure or a cached data object

Depuis:

11.1

A faire:

Review this method. The docblock doesn't fit what it actually does.

Réimplémentée dans JCacheStorageMemcached, JCacheStorageMemcache, JCacheStorageCachelite, JCacheStorageFile, JCacheStorageWincache, JCacheStorageXcache, et JCacheStorageApc.

Définition à la ligne 175 du fichier storage.php.

        {
                if (!class_exists('JCacheStorageHelper', false))
                {
                        include_once JPATH_PLATFORM . '/joomla/cache/storage/helper.php';
                }
                return;
        }

static JCacheStorage::getInstance (   $handler = null,   $options = array()  )

static

Returns a cache storage handler object, only creating it if it doesn't already exist.

Paramètres:

string	$handler	The cache storage handler to instantiate
array	$options	Array of handler options

Renvoie:

JCacheStorage A JCacheStorage instance

Depuis:

11.1

Exceptions:

UnexpectedValueException
RuntimeException

Définition à la ligne 107 du fichier storage.php.

Références JPath\find(), JFactory\getConfig(), et jimport().

Référencé par JCache\_getStorage().

        {
                static $now = null;

                self::addIncludePath(JPATH_PLATFORM . '/joomla/cache/storage');

                if (!isset($handler))
                {
                        $conf = JFactory::getConfig();
                        $handler = $conf->get('cache_handler');
                        if (empty($handler))
                        {
                                throw new UnexpectedValueException('Cache Storage Handler not set.');
                        }
                }

                if (is_null($now))
                {
                        $now = time();
                }

                $options['now'] = $now;

                // We can't cache this since options may change...
                $handler = strtolower(preg_replace('/[^A-Z0-9_\.-]/i', '', $handler));

                $class = 'JCacheStorage' . ucfirst($handler);
                if (!class_exists($class))
                {
                        // Search for the class file in the JCacheStorage include paths.
                        jimport('joomla.filesystem.path');
                        if ($path = JPath::find(self::addIncludePath(), strtolower($handler) . '.php'))
                        {
                                include_once $path;
                        }
                        else
                        {
                                throw new RuntimeException(sprintf('Unable to load Cache Storage: %s', $handler));
                        }
                }

                return new $class($options);
        }

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

static JCacheStorage::isSupported ( )

static

Test to see if the storage handler is available.

Renvoie:

boolean True on success, false otherwise

Depuis:

12.1.

Réimplémentée dans JCacheStorageCachelite, JCacheStorageMemcached, JCacheStorageMemcache, JCacheStorageFile, JCacheStorageXcache, JCacheStorageWincache, et JCacheStorageApc.

Définition à la ligne 251 du fichier storage.php.

        {
                return true;
        }

JCacheStorage::lock	(		$id,
			$group,
			$locktime
	)

Lock cached item

Paramètres:

string	$id	The cache data id
string	$group	The cache data group
integer	$locktime	Cached item max lock time

Renvoie:

boolean True on success, false otherwise.

Depuis:

11.1

Réimplémentée dans JCacheStorageMemcached, JCacheStorageMemcache, JCacheStorageFile, et JCacheStorageApc.

Définition à la ligne 282 du fichier storage.php.

        {
                return false;
        }

JCacheStorage::remove	(		$id,
			$group
	)

Remove a cached data entry by id and group

Paramètres:

string	$id	The cache data id
string	$group	The cache data group

Renvoie:

boolean True on success, false otherwise

Depuis:

11.1

Réimplémentée dans JCacheStorageMemcached, JCacheStorageMemcache, JCacheStorageCachelite, JCacheStorageFile, JCacheStorageWincache, JCacheStorageXcache, et JCacheStorageApc.

Définition à la ligne 210 du fichier storage.php.

        {
                return true;
        }

JCacheStorage::store	(		$id,
			$group,
			$data
	)

Store the data to cache by id and group

Paramètres:

string	$id	The cache data id
string	$group	The cache data group
string	$data	The data to store in cache

Renvoie:

boolean True on success, false otherwise

Depuis:

11.1

Réimplémentée dans JCacheStorageMemcached, JCacheStorageMemcache, JCacheStorageCachelite, JCacheStorageFile, JCacheStorageWincache, JCacheStorageXcache, et JCacheStorageApc.

Définition à la ligne 195 du fichier storage.php.

        {
                return true;
        }

static JCacheStorage::test ( )

static

Test to see if the storage handler is available.

Renvoie:

boolean True on success, false otherwise.

Depuis:

11.1

Obsolète:

12.3 (Platform) & 4.0 (CMS)

Définition à la ligne 264 du fichier storage.php.

Références JLog\add(), et JLog\WARNING.

        {
                JLog::add('JCacheStorage::test() is deprecated. Use JCacheStorage::isSupported() instead.', JLog::WARNING, 'deprecated');

                return static::isSupported();
        }

Voici le graphe d'appel pour cette fonction :

JCacheStorage::unlock	(		$id,
			$group = null
	)

Unlock cached item

Paramètres:

string	$id	The cache data id
string	$group	The cache data group

Renvoie:

boolean True on success, false otherwise.

Depuis:

11.1

Réimplémentée dans JCacheStorageMemcached, JCacheStorageMemcache, JCacheStorageFile, et JCacheStorageApc.

Définition à la ligne 297 du fichier storage.php.

        {
                return false;
        }

---

Documentation des données membres

JCacheStorage::$_application

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

JCacheStorage::$_hash

Définition à la ligne 61 du fichier storage.php.

JCacheStorage::$_language

Définition à la ligne 49 du fichier storage.php.

JCacheStorage::$_lifetime

Définition à la ligne 37 du fichier storage.php.

JCacheStorage::$_locking

Définition à la ligne 43 du fichier storage.php.

JCacheStorage::$_now

Définition à la ligne 31 du fichier storage.php.

JCacheStorage::$rawname

protected

Définition à la ligne 25 du fichier storage.php.

---

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

• jplatform-13.1/joomla/cache/storage.php