Difference between revisions of "JTable/isCheckedOut"
From Joomla! Documentation
< API15:JTable
(New page: ===Description===
Check if an item is checked out
<span class="editsection" style="font-size:76%;">
<nowiki>[</nowiki>Edit Descripton<nowiki>]</now...) |
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>[<! removed edit link to red link >]</nowiki> |
</span> | </span> | ||
| − | + | <! removed transcluded page call, red link never existed > | |
===Syntax=== | ===Syntax=== | ||
| Line 53: | Line 53: | ||
<span class="editsection" style="font-size:76%;"> | <span class="editsection" style="font-size:76%;"> | ||
| − | <nowiki>[< | + | <nowiki>[<! removed edit link to red link >]</nowiki> |
</span> | </span> | ||
| − | + | <! removed transcluded page call, red link never existed > | |
===Examples=== | ===Examples=== | ||
| Line 68: | Line 68: | ||
format= ,,, | format= ,,, | ||
</dpl> | </dpl> | ||
| + | [[Category:Archived pages API15]] | ||
Revision as of 13:52, 12 May 2013
The "API15" 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]
Check if an item is checked out
[<! removed edit link to red link >]
<! removed transcluded page call, red link never existed >
Syntax[edit]
isCheckedOut($with=0, $against=null)| Parameter Name | Default Value | Description |
|---|---|---|
| $with | 0 | $with The userid to preform the match with, if an item is checked out by this user the function will return false |
| $against | null | $against The userid to perform the match against when the function is used as a static function. |
Returns[edit]
boolean
Defined in[edit]
libraries/joomla/database/table.php
Importing[edit]
jimport( 'joomla.database.table' );Source Body[edit]
function isCheckedOut( $with = 0, $against = null)
{
if(isset($this) && is_a($this, 'JTable') && is_null($against)) {
$against = $this->get( 'checked_out' );
}
//item is not checked out, or being checked out by the same user
if (!$against || $against == $with) {
return false;
}
$session =& JTable::getInstance('session');
return $session->exists($against);
}[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >
Examples[edit]
<CodeExamplesForm />