View source for JModelForm/checkout

===Description===
Method to check-out a row for editing.





===Syntax===
<source lang="php">checkout($pk=null)</source>

 {| class="wikitable"
|-
!Parameter Name
!Default Value
!Description
|-
| $pk
| null
|  $pk The numeric id of the primary key.
|}

===Returns===
boolean False on failure or error, true otherwise. 

===Defined in===
libraries/joomla/application/component/modelform.php
===Importing===
<source lang="php">jimport( 'joomla.application.component.modelform' );</source>

===Source Body===
<source lang="php">
public function checkout($pk = null)
{
        // Only attempt to check the row in if it exists.
        if ($pk)
        {
                $user = JFactory::getUser();

                // Get an instance of the row to checkout.
                $table = $this->getTable();
                if (!$table->load($pk)) {
                        $this->setError($table->getError());
                        return false;
                }

                // Check if this is the user having previously checked out the row.
                if ($table->checked_out > 0 && $table->checked_out != $user->get('id'))
                {
                        $this->setError(JText::_('JError_Checkout_user_mismatch'));
                        return false;
                }

                // Attempt to check the row out.
                if (!$table->checkout($user->get('id'), $pk))
                {
                        $this->setError($table->getError());
                        return false;
                }
        }

        return true;
}
</source>




===Examples===
=== Code Examples ===
<dpl>
 noresultsheader=\n
 category=checkout
 category=JModelForm
 namespace=CodeExample
 category=MethodExample
 include=*
 format= ,,,
</dpl>