Actions

API15

JTable/checkout

From Joomla! Documentation

< API15:JTable
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

Checks out a row

[<! removed edit link to red link >]

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

Syntax

checkout($who, $oid=null)
Parameter Name Default Value Description
$who The id of the user
$oid null The primary key value for the row

Returns

boolean True if successful, or if checkout is not supported

Defined in

libraries/joomla/database/table.php

Importing

jimport( 'joomla.database.table' );

Source Body

function checkout( $who, $oid = null )
{
        if (!in_array( 'checked_out', array_keys($this->getProperties()) )) {
                return true;
        }
 
        $k = $this->_tbl_key;
        if ($oid !== null) {
                $this->$k = $oid;
        }
 
        $date =& JFactory::getDate();
        $time = $date->toMysql();
 
        $query = 'UPDATE '.$this->_db->nameQuote( $this->_tbl ) .
                ' SET checked_out = '.(int)$who.', checked_out_time = '.$this->_db->Quote($time) .
                ' WHERE '.$this->_tbl_key.' = '. $this->_db->Quote($this->$k);
        $this->_db->setQuery( $query );
 
        $this->checked_out = $who;
        $this->checked_out_time = $time;
 
        return $this->_db->query();
}

[<! removed edit link to red link >] <! removed transcluded page call, red link never existed >

Examples

<CodeExamplesForm />