API17

Difference between revisions of "JCache::remove"

From Joomla! Documentation

(Layout updates)
(Updated to r1448:247ba8d88526)
Line 8: Line 8:
 
<nowiki>[</nowiki>[[Description:JCache::remove|Edit Descripton]]<nowiki>]</nowiki>
 
<nowiki>[</nowiki>[[Description:JCache::remove|Edit Descripton]]<nowiki>]</nowiki>
 
</span>
 
</span>
===Since===
 
{{JVer|11.1 }}
 
===Synopsis===
 
 
<source lang="php">
 
<source lang="php">
public JCache::remove ($id, $group=null)
+
public function remove (
 +
        $id
 +
        $group=null
 +
)
 
</source>
 
</source>
 
{| class="wikitable"
 
{| class="wikitable"
Line 32: Line 32:
 
|-
 
|-
 
|}
 
|}
===Returns===
+
* '''Returns''' boolean True on success, false otherwise
boolean True on success, false otherwise
+
* '''Defined''' on line 220 of libraries/joomla/cache/cache.php
===Defined in===
+
* '''Since''' {{JVer|11.1 }}
libraries/joomla/cache/cache.php (line 220)
 
* see source code in [[jplatform:cache/cache.php#cl-220|BitBucket]]
 
===Referenced by===
 
 
===See also===
 
===See also===
 +
* {{JVer|11.1}} '''JCache::remove source code''' on [[jplatform:cache/cache.php#cl-212|BitBucket]]
 +
* {{JVer|11.1}} Class [[JCache/11.1|JCache]]
 +
* {{JVer|11.1}} Subpackage [[Subpackage_Cache/11.1|Cache]]
 +
* [[JCache::remove|Other versions of JCache::remove]]
 +
{{SeeAlso:JCache::remove}}
 
<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>[</nowiki>[[SeeAlso:JCache::remove|Edit See Also]]<nowiki>]</nowiki>
 
</span>
 
</span>
* [[JCache/11.1|JCache]]
+
===User contributed notes===
* [[JCache::remove|Other versions of this method]]
 
{{SeeAlso:JCache::remove}}
 
===Examples===
 
 
<CodeExamplesForm />
 
<CodeExamplesForm />
 
<dpl>
 
<dpl>
Line 53: Line 52:
 
category=MethodExample
 
category=MethodExample
 
include=*
 
include=*
 +
namespace=CodeExample
 
format= ,,,
 
format= ,,,
 
</dpl>
 
</dpl>
 
<noinclude>[[Category:JCache]][[Category:JCache::remove]]</noinclude>
 
<noinclude>[[Category:JCache]][[Category:JCache::remove]]</noinclude>

Revision as of 20:14, 27 April 2011

The "API17" 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.

Joomla 11.1 JCache::remove[edit]

Description[edit]

Remove a cached data entry by id and group.

Template:Description:JCache::remove [Edit Descripton]

public function remove (
        $id
        $group=null
)
Parameter Type Default Description
$id string The cache data id
$group string null The cache data group
  • Returns boolean True on success, false otherwise
  • Defined on line 220 of libraries/joomla/cache/cache.php
  • Since Joomla 11.1

See also[edit]

Template:SeeAlso:JCache::remove [Edit See Also]

User contributed notes[edit]

<CodeExamplesForm />