API15

JTable/isCheckedOut: Difference between revisions

From Joomla! Documentation

Doxiki (talk | contribs)
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>[[Description:JTable/isCheckedOut|Edit Descripton]]<nowiki>]</nowiki>
<nowiki>[<! removed edit link to red link >]</nowiki>
</span>
</span>


{{Description:JTable/isCheckedOut}}
<! 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>[[SeeAlso:JTable/isCheckedOut|Edit See Also]]<nowiki>]</nowiki>
<nowiki>[<! removed edit link to red link >]</nowiki>
</span>
</span>
{{SeeAlso:JTable/isCheckedOut}}
<! 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 18:52, 12 May 2013

Description

Check if an item is checked out

[<! removed edit link to red link >]

<! removed transcluded page call, red link never existed >

Syntax

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

boolean

Defined in

libraries/joomla/database/table.php

Importing

jimport( 'joomla.database.table' );

Source Body

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

<CodeExamplesForm />