Actions

API17

Difference between revisions of "JCache::lock"

From Joomla! Documentation

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

Revision as of 20:14, 27 April 2011

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.

Joomla 11.1 JCache::lock

Description

Set lock flag on cached item.

Description:JCache::lock [Edit Descripton]

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

See also

SeeAlso:JCache::lock [Edit See Also]

User contributed notes

<CodeExamplesForm />