API15

Difference between revisions of "JCacheStorageFile/get"

From Joomla! Documentation

< API15:JCacheStorageFile
(New page: ===Description=== Get cached data from a file by id and group <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>Edit Descripton...)
 
m (removing red link to edit, no existant pages)
Line 3: Line 3:
  
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[Description:JCacheStorageFile/get|Edit Descripton]]<nowiki>]</nowiki>
+
<nowiki>[<! removed edit link to red link >]</nowiki>
 
</span>
 
</span>
  
{{Description:JCacheStorageFile/get}}
+
<! removed transcluded page call, red link never existed >
  
 
===Syntax===
 
===Syntax===
Line 59: Line 59:
  
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[SeeAlso:JCacheStorageFile/get|Edit See Also]]<nowiki>]</nowiki>
+
<nowiki>[<! removed edit link to red link >]</nowiki>
 
</span>
 
</span>
{{SeeAlso:JCacheStorageFile/get}}
+
<! removed transcluded page call, red link never existed >
  
 
===Examples===
 
===Examples===
Line 74: Line 74:
 
  format= ,,,
 
  format= ,,,
 
</dpl>
 
</dpl>
 +
[[Category:Archived pages API15]]

Revision as of 08:50, 12 May 2013

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 />