JCache/clean
From Joomla! Documentation
< API16:JCacheRevision as of 17:38, 22 March 2010 by Doxiki (talk | contribs) (New page: ===Description===
Clean cache for a group given a mode.
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>Edit Descripton<nowiki>]</nowi...)
Revision as of 17:38, 22 March 2010 by Doxiki (talk | contribs) (New page: ===Description===
Clean cache for a group given a mode.
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>Edit Descripton<nowiki>]</nowi...)
The "API16" 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]
Clean cache for a group given a mode.
Template:Description:JCache/clean
Syntax[edit]
clean($group=null, $mode='group')| Parameter Name | Default Value | Description |
|---|---|---|
| $group | null | $group The cache data group |
| $mode | 'group' | notgroup] |
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 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;
}[Edit See Also] Template:SeeAlso:JCache/clean
Examples[edit]
<CodeExamplesForm />