JTable::checkOut
Method to check a row out if the necessary properties/fields exist. To prevent race conditions while editing rows in a database, a row can be checked out if the fields 'checked_out' and 'checked_out_time' are available.
While a row is checked out, any attempt to store the row by a user other than the one who checked the row out should be held until the row is checked in again.
Signature
public function checkOut(integer
$userId,
[mixed
$pk = null] )
Parameters
-
$userId
- The Id of the user checking out the row.
-
$pk
- An optional primary key value to check out. If not set
Returns
- boolean
- True on success.