API15

Difference between revisions of "JCache/remove"

From Joomla! Documentation

< API15:JCache
(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 (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:JCache/remove|Edit Descripton]]<nowiki>]</nowiki>
+
<nowiki>[<! removed edit link to red link >]</nowiki>
 
</span>
 
</span>
  
{{Description:JCache/remove}}
+
<! removed transcluded page call, red link never existed >
  
 
===Syntax===
 
===Syntax===
Line 51: Line 51:
  
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[SeeAlso:JCache/remove|Edit See Also]]<nowiki>]</nowiki>
+
<nowiki>[<! removed edit link to red link >]</nowiki>
 
</span>
 
</span>
{{SeeAlso:JCache/remove}}
+
<! removed transcluded page call, red link never existed >
  
 
===Examples===
 
===Examples===
Line 66: Line 66:
 
  format= ,,,
 
  format= ,,,
 
</dpl>
 
</dpl>
 +
[[Category:Archived pages API15]]

Revision as of 08:48, 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]

Remove a cached data entry by id and group

[<! removed edit link to red link >]

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

Syntax[edit]

remove($id, $group=null)
Parameter Name Default Value Description
$id $id The cache data id
$group null $group The cache data group

Returns[edit]

boolean True on success, false otherwise

Defined in[edit]

libraries/joomla/cache/cache.php

Importing[edit]

jimport( 'joomla.cache.cache' );

Source Body[edit]

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 edit link to red link >] <! removed transcluded page call, red link never existed >

Examples[edit]

<CodeExamplesForm />