API15

API15:JTable/isCheckedOut

From Joomla! Documentation

Revision as of 22:16, 22 March 2010 by 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...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Description

Check if an item is checked out

[Edit Descripton]

Template:Description:JTable/isCheckedOut

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);
}

[Edit See Also] Template:SeeAlso:JTable/isCheckedOut

Examples

<CodeExamplesForm />