Actions

API15

JTable/isCheckedOut

From Joomla! Documentation

< API15:JTable
Revision as of 13:52, 12 May 2013 by JoomlaWikiBot (Talk | contribs)

(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
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.

Contents

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 />