JCache/remove: Difference between revisions
From Joomla! Documentation
New page: ===Description===
Remove a cached data entry by id and group
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>Edit Descripton<nowiki>]... |
m preparing for archive only |
||
| (2 intermediate revisions by the same user not shown) | |||
| Line 2: | Line 2: | ||
Remove a cached data entry by id and group | Remove a cached data entry by id and group | ||
<! removed transcluded page call, red link never existed > | |||
===Syntax=== | ===Syntax=== | ||
| Line 50: | Line 48: | ||
</source> | </source> | ||
<! removed transcluded page call, red link never existed > | |||
< | |||
===Examples=== | ===Examples=== | ||
=== Code Examples === | |||
<dpl> | <dpl> | ||
noresultsheader=\n | noresultsheader=\n | ||
category=remove | category=remove | ||
category=JCache | category=JCache | ||
namespace=CodeExample | |||
category=MethodExample | category=MethodExample | ||
include=* | include=* | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
[[Category:Archived pages API16]] | |||
Latest revision as of 01:21, 25 March 2017
Description
Remove a cached data entry by id and group
<! removed transcluded page call, red link never existed >
Syntax
remove($id, $group=null)
| Parameter Name | Default Value | Description |
|---|---|---|
| $id | $id The cache data id | |
| $group | null | $group The cache data group |
Returns
boolean True on success, false otherwise
Defined in
libraries/joomla/cache/cache.php
Importing
jimport( 'joomla.cache.cache' );
Source Body
function remove($id, $group=null)
{
// Get the default group
$group = ($group) ? $group : $this->_options['defaultgroup'];
// Get the storage handler
$handler = &$this->_getStorage();
if (!JError::isError($handler)) {
return $handler->remove($id, $group);
}
return false;
}
<! removed transcluded page call, red link never existed >
Examples
Code Examples