Actions

API16

JFactory/getCache

From Joomla! Documentation

< API16:JFactory
Revision as of 00:06, 13 May 2013 by JoomlaWikiBot (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Contents

Description

Get a cache object

[<! removed edit link to red link >]

<! removed transcluded page call, red link never existed >

Syntax

static 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

public static 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;
}

[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />