API15

Difference between revisions of "JCacheStorageXCache/remove"

From Joomla! Documentation

< API15:JCacheStorageXCache
(New page: ===Description=== Remove a cached data entry by id and group <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>[[Description:JCacheStorageXCache/remove|Edit Descript...)
 
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>[[Description:JCacheStorageXCache/remove|Edit Descripton]]<nowiki>]</nowiki>
+
<nowiki>[<! removed edit link to red link >]</nowiki>
 
</span>
 
</span>
  
{{Description:JCacheStorageXCache/remove}}
+
<! removed transcluded page call, red link never existed >
  
 
===Syntax===
 
===Syntax===
Line 49: Line 49:
  
 
<span class="editsection" style="font-size:76%;">
 
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>[[SeeAlso:JCacheStorageXCache/remove|Edit See Also]]<nowiki>]</nowiki>
+
<nowiki>[<! removed edit link to red link >]</nowiki>
 
</span>
 
</span>
{{SeeAlso:JCacheStorageXCache/remove}}
+
<! removed transcluded page call, red link never existed >
  
 
===Examples===
 
===Examples===
<CodeExamplesForm />
+
=== Code Examples ===
 
<dpl>
 
<dpl>
 
  noresultsheader=\n
 
  noresultsheader=\n
 
  category=remove
 
  category=remove
 
  category=JCacheStorageXCache
 
  category=JCacheStorageXCache
  category=CodeExample
+
  namespace=CodeExample
 
  category=MethodExample
 
  category=MethodExample
 
  include=*
 
  include=*
 
  format= ,,,
 
  format= ,,,
 
</dpl>
 
</dpl>
 +
[[Category:Archived pages API15]]

Latest revision as of 19:23, 24 March 2017

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)
Parameter Name Default Value Description
$id $id The cache data id
$group $group The cache data group

Returns[edit]

boolean True on success, false otherwise

Defined in[edit]

libraries/joomla/cache/storage/xcache.php

Importing[edit]

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

Source Body[edit]

function remove($id, $group)
{
        $cache_id = $this->_getCacheId($id, $group);

        if( !xcache_isset( $cache_id ) ){
                return true;
        }

        return xcache_unset($cache_id);
}

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

Examples[edit]

Code Examples[edit]