API15

JCacheStorageFile/get

From Joomla! Documentation

< API15:JCacheStorageFile
Revision as of 08:50, 12 May 2013 by JoomlaWikiBot (talk | contribs) (removing red link to edit, no existant pages)
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

The "API15" 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 from a file by id and group

[<! removed edit link to red link >]

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

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/file.php

Importing[edit]

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

Source Body[edit]

function get($id, $group, $checkTime)
{
        $data = false;

        $path = $this->_getFilePath($id, $group);
        $this->_setExpire($id, $group);
        if (file_exists($path)) {
                $data = file_get_contents($path);
                if($data) {
                        // Remove the initial die() statement
                        $data   = preg_replace('/^.*\n/', '', $data);
                }
        }

        return $data;
}

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

Examples[edit]

<CodeExamplesForm />