API16

JCache/get

From Joomla! Documentation

< API16:JCache
Revision as of 17:38, 22 March 2010 by Doxiki (talk | contribs) (New page: ===Description=== Get cached data by id and group <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>Edit Descripton<nowiki>]</nowiki> </s...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

The "API16" namespace is an archived namespace. This page contains information for a Joomla! version which is no longer supported. It exists only as a historical reference, it will not be improved and its content may be incomplete and/or contain broken links.

Description[edit]

Get cached data by id and group

[Edit Descripton]

Template:Description:JCache/get

Syntax[edit]

get($id, $group=null)
Parameter Name Default Value Description
$id $id The cache data id
$group null $group The cache data group

Returns[edit]

mixed Boolean false on failure or a cached data string

Defined in[edit]

libraries/joomla/cache/cache.php

Importing[edit]

jimport( 'joomla.cache.cache' );

Source Body[edit]

function get($id, $group=null)
{
        // Get the default group
        $group = ($group) ? $group : $this->_options['defaultgroup'];

        // Get the storage handler
        $handler = &$this->_getStorage();
        if (!JError::isError($handler) && $this->_options['caching']) {
                return $handler->get($id, $group, (isset($this->_options['checkTime']))? $this->_options['checkTime'] : true);
        }
        return false;
}

[Edit See Also] Template:SeeAlso:JCache/get

Examples[edit]

<CodeExamplesForm />