Actions

API17

Difference between revisions of "JCacheStorage::lock"

From Joomla! Documentation

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

Revision as of 20:16, 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 JCacheStorage::lock

Description

Lock cached item.

Description:JCacheStorage::lock [Edit Descripton]

public function lock (
        $id
        $group
        $locktime
)
Parameter Type Default Description
$id string The cache data id
$group string The cache data group
$locktime integer Cached item max lock time
  • Returns boolean True on success, false otherwise.
  • Defined on line 230 of libraries/joomla/cache/storage.php
  • Since Joomla 11.1

See also

SeeAlso:JCacheStorage::lock [Edit See Also]

User contributed notes

<CodeExamplesForm />