API15

JCache/get: Difference between revisions

From Joomla! Documentation

m removing red link to edit, no existant pages
m preparing for archive only
 
Line 56: Line 56:


===Examples===
===Examples===
<CodeExamplesForm />
=== Code Examples ===
<dpl>
<dpl>
  noresultsheader=\n
  noresultsheader=\n
  category=get
  category=get
  category=JCache
  category=JCache
  category=CodeExample
  namespace=CodeExample
  category=MethodExample
  category=MethodExample
  include=*
  include=*

Latest revision as of 00:21, 25 March 2017

Description

Get cached data by id and group

[<! removed edit link to red link >]

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

Syntax

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

Returns

mixed Boolean false on failure or a cached data string

Defined in

libraries/joomla/cache/cache.php

Importing

jimport( 'joomla.cache.cache' );

Source Body

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

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

Examples

Code Examples