Actions

API15

Difference between revisions of "JCache/clean"

From Joomla! Documentation

< API15:JCache
(New page: ===Description=== Clean cache for a group given a mode. <span class="editsection" style="font-size:76%;"> <nowiki>[</nowiki>Edit Descripton<nowiki>]</nowi...)
 
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/clean|Edit Descripton]]<nowiki>]</nowiki>
+
<nowiki>[<! removed edit link to red link >]</nowiki>
 
</span>
 
</span>
  
{{Description:JCache/clean}}
+
<! 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/clean|Edit See Also]]<nowiki>]</nowiki>
+
<nowiki>[<! removed edit link to red link >]</nowiki>
 
</span>
 
</span>
{{SeeAlso:JCache/clean}}
+
<! removed transcluded page call, red link never existed >
  
 
===Examples===
 
===Examples===
Line 66: Line 66:
 
  format= ,,,
 
  format= ,,,
 
</dpl>
 
</dpl>
 +
[[Category:Archived pages API15]]

Latest revision as of 08:47, 12 May 2013

Replacement filing cabinet.png
This Namespace has been archived - Please Do Not Edit or Create Pages in this namespace. Pages contain information for a Joomla! version which is no longer supported. It exists only as a historical reference, will not be improved and its content may be incomplete.

Contents

Description

Clean cache for a group given a mode.

[<! removed edit link to red link >]

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

Syntax

clean($group=null, $mode='group')
Parameter Name Default Value Description
$group null $group The cache data group
$mode 'group' notgroup]

Returns

boolean True on success, false otherwise

Defined in

libraries/joomla/cache/cache.php

Importing

jimport( 'joomla.cache.cache' );

Source Body

function clean($group=null, $mode='group')
{
        // Get the default group
        $group = ($group) ? $group : $this->_options['defaultgroup'];
 
        // Get the storage handler
        $handler =& $this->_getStorage();
        if (!JError::isError($handler)) {
                return $handler->clean($group, $mode);
        }
        return false;
}

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

Examples

<CodeExamplesForm />