API16

JCacheStorageXCache/get

From Joomla! Documentation

< API16:JCacheStorageXCache
Revision as of 17:39, 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>]<...)
(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:JCacheStorageXCache/get

Syntax[edit]

get($id, $group, $checkTime)
Parameter Name Default Value Description
$id $id The cache data id
$group $group The cache data group
$checkTime $checkTime True to verify cache time expiration threshold

Returns[edit]

mixed Boolean false on failure or a cached data string

Defined in[edit]

libraries/joomla/cache/storage/xcache.php

Importing[edit]

jimport( 'joomla.cache.storage.xcache' );

Source Body[edit]

function get($id, $group, $checkTime)
{
        $cache_id = $this->_getCacheId($id, $group);

        //check if id exists
        if (!xcache_isset($cache_id)){
                return false;
        }

        return xcache_get($cache_id);
}

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

Examples[edit]

<CodeExamplesForm />