JTable/checkIn
From Joomla! Documentation
< API16:JTable
The "API16" 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]
Method to check a row in if the necessary properties/fields exist. Checking a row in will allow other users the ability to edit the row.
Syntax[edit]
checkIn($pk=null)
Parameter Name | Default Value | Description |
---|---|---|
$pk | null | An optional primary key value to check out. If not set the instance property value is used. |
Returns[edit]
boolean True on success.
Defined in[edit]
libraries/joomla/database/table.php
Importing[edit]
jimport( 'joomla.database.table' );
Source Body[edit]
public function checkIn($pk = null)
{
// If there is no checked_out or checked_out_time field, just return true.
if (!property_exists($this, 'checked_out') || !property_exists($this, 'checked_out_time')) {
return true;
}
// Initialise variables.
$k = $this->_tbl_key;
$pk = (is_null($pk)) ? $this->$k : $pk;
// If no primary key is given, return false.
if ($pk === null) {
return false;
}
// Check the row in by primary key.
$this->_db->setQuery(
'UPDATE `'.$this->_tbl.'`' .
' SET `checked_out` = 0,' .
' `checked_out_time` = '.$this->_db->quote($this->_db->getNullDate()) .
' WHERE `'.$this->_tbl_key.'` = '.$this->_db->quote($pk)
);
$this->_db->query();
// Check for a database error.
if ($this->_db->getErrorNum()) {
$this->setError($this->_db->getErrorMsg());
return false;
}
// Set table values in the object.
$this->checked_out = 0;
$this->checked_out_time = '';
return true;
}
Examples[edit]
Code Examples[edit]