API15

JCacheStorageXCache/remove: Difference between revisions

From Joomla! Documentation

m removing red link to edit, no existant pages
m preparing for archive only
 
Line 54: Line 54:


===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=*

Latest revision as of 00:23, 25 March 2017

Description

Remove a cached data entry by id and group

[<! removed edit link to red link >]

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

Syntax

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

Returns

boolean True on success, false otherwise

Defined in

libraries/joomla/cache/storage/xcache.php

Importing

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

Source Body

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

Code Examples