Référence de la classe JCacheController

Graphe d'héritage de JCacheController:

Liste de tous les membres

Fonctions membres publiques
	__construct ($options)
	__call ($name, $arguments)
	setCaching ($enabled)
	setLifeTime ($lt)
	get ($id, $group=null)
	store ($data, $id, $group=null, $wrkarounds=true)

Fonctions membres publiques statiques
static	getInstance ($type= 'output', $options=array())
static	addIncludePath ($path= '')

Attributs publics
	$cache
	$options

---

Description détaillée

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

---

Documentation des constructeurs et destructeur

JCacheController::__construct

(

$options

)

Constructor

Paramètres:

array

$options

Array of options

Depuis:

11.1

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

        {
                $this->cache = new JCache($options);
                $this->options = & $this->cache->_options;

                // Overwrite default options with given options
                foreach ($options as $option => $value)
                {
                        if (isset($options[$option]))
                        {
                                $this->options[$option] = $options[$option];
                        }
                }
        }

---

Documentation des fonctions membres

JCacheController::__call	(		$name,
			$arguments
	)

Magic method to proxy JCacheControllerMethods

Paramètres:

string	$name	Name of the function
array	$arguments	Array of arguments for the function

Renvoie:

mixed

Depuis:

11.1

Définition à la ligne 69 du fichier controller.php.

        {
                $nazaj = call_user_func_array(array($this->cache, $name), $arguments);
                return $nazaj;
        }

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

static

Add a directory where JCache should search for controllers. 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 150 du fichier controller.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 :

JCacheController::get	(		$id,
			$group = null
	)

Get stored cached data by id and group

Paramètres:

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

Renvoie:

mixed False on no result, cached object otherwise

Depuis:

11.1

Réimplémentée dans JCacheControllerPage.

Définition à la ligne 176 du fichier controller.php.

        {
                $data = $this->cache->get($id, $group);

                if ($data === false)
                {
                        $locktest = new stdClass;
                        $locktest->locked = null;
                        $locktest->locklooped = null;
                        $locktest = $this->cache->lock($id, $group);
                        if ($locktest->locked == true && $locktest->locklooped == true)
                        {
                                $data = $this->cache->get($id, $group);
                        }
                        if ($locktest->locked == true)
                        {
                                $this->cache->unlock($id, $group);
                        }
                }

                // Check again because we might get it from second attempt
                if ($data !== false)
                {
                        // Trim to fix unserialize errors
                        $data = unserialize(trim($data));
                }
                return $data;
        }

static JCacheController::getInstance (   $type = 'output',   $options = array()  )

static

Returns a reference to a cache adapter object, always creating it

Paramètres:

string	$type	The cache object type to instantiate; default is output.
array	$options	Array of options

Renvoie:

JCache A JCache object

Depuis:

11.1

Exceptions:

RuntimeException

Définition à la ligne 86 du fichier controller.php.

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

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

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

                $type = strtolower(preg_replace('/[^A-Z0-9_\.-]/i', '', $type));

                $class = 'JCacheController' . ucfirst($type);

                if (!class_exists($class))
                {
                        // Search for the class file in the JCache include paths.
                        jimport('joomla.filesystem.path');

                        if ($path = JPath::find(self::addIncludePath(), strtolower($type) . '.php'))
                        {
                                include_once $path;
                        }
                        else
                        {
                                throw new RuntimeException('Unable to load Cache Controller: ' . $type, 500);
                        }
                }

                return new $class($options);
        }

Voici le graphe d'appel pour cette fonction :

Voici le graphe des appelants de cette fonction :

JCacheController::setCaching

(

$enabled

)

Set caching enabled state

Paramètres:

boolean

$enabled

True to enable caching

Renvoie:

void

Depuis:

11.1

Définition à la ligne 121 du fichier controller.php.

        {
                $this->cache->setCaching($enabled);
        }

JCacheController::setLifeTime

(

$lt

)

Set cache lifetime

Paramètres:

integer

$lt

Cache lifetime

Renvoie:

void

Depuis:

11.1

Définition à la ligne 135 du fichier controller.php.

        {
                $this->cache->setLifeTime($lt);
        }

JCacheController::store	(		$data,
			$id,
			$group = null,
			$wrkarounds = true
	)

Store data to cache by id and group

Paramètres:

mixed	$data	The data to store
string	$id	The cache data id
string	$group	The cache data group
boolean	$wrkarounds	True to use wrkarounds

Renvoie:

boolean True if cache stored

Depuis:

11.1

Réimplémentée dans JCacheControllerPage.

Définition à la ligne 217 du fichier controller.php.

        {
                $locktest = new stdClass;
                $locktest->locked = null;
                $locktest->locklooped = null;

                $locktest = $this->cache->lock($id, $group);

                if ($locktest->locked == false && $locktest->locklooped == true)
                {
                        $locktest = $this->cache->lock($id, $group);
                }

                $sucess = $this->cache->store(serialize($data), $id, $group);

                if ($locktest->locked == true)
                {
                        $this->cache->unlock($id, $group);
                }

                return $sucess;
        }

---

Documentation des données membres

JCacheController::$cache

Définition à la ligne 27 du fichier controller.php.

JCacheController::$options

Définition à la ligne 35 du fichier controller.php.

---

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

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