Joomla! Documentation™

Description

Get a cache object

Syntax

& getCache($group= '', $handler= 'callback', $storage=null)

Parameter Name	Default Value	Description
$group		The cache group name
$handler	'callback'	The handler to use
$storage	null	The storage method

Returns

object

Defined in

libraries/joomla/factory.php

Importing

jimport( 'joomla.factory' );

Source Body

function &getCache($group = '', $handler = 'callback', $storage = null)
{
        $handler = ($handler == 'function') ? 'callback' : $handler;

        $conf =& JFactory::getConfig();

        if(!isset($storage)) {
                $storage = $conf->getValue('config.cache_handler', 'file');
        }

        $options = array(
                'defaultgroup'  => $group,
                'cachebase'     => $conf->getValue('config.cache_path'),
                'lifetime'              => $conf->getValue('config.cachetime') * 60,    // minutes to seconds
                'language'              => $conf->getValue('config.language'),
                'storage'               => $storage
        );

        jimport('joomla.cache.cache');

        $cache =& JCache::getInstance( $handler, $options );
        $cache->setCaching($conf->getValue('config.caching'));
        return $cache;
}

Examples

<CodeExamplesForm />