JCacheStorageFile/get: Difference between revisions
From Joomla! Documentation
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 preparing for archive only |
||
| (One intermediate revision by the same user not shown) | |||
| Line 3: | Line 3: | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
<nowiki>[< | <nowiki>[<! removed edit link to red link >]</nowiki> | ||
</span> | </span> | ||
<! 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>[<! removed edit link to red link >]</nowiki> | ||
</span> | </span> | ||
<! removed transcluded page call, red link never existed > | |||
===Examples=== | ===Examples=== | ||
=== Code Examples === | |||
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=get | category=get | ||
category=JCacheStorageFile | category=JCacheStorageFile | ||
namespace=CodeExample | |||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
[[Category:Archived pages API15]] | |||
Latest revision as of 00:22, 25 March 2017
Description
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
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
mixed Boolean false on failure or a cached data string
Defined in
libraries/joomla/cache/storage/file.php
Importing
jimport( 'joomla.cache.storage.file' );
Source Body
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
Code Examples