API16:JControllerForm/cancel

Description

Method to cancel an edit

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

Syntax

cancel()

Defined in

libraries/joomla/application/component/controllerform.php

Importing

jimport( 'joomla.application.component.controllerform' );

Source Body

public function cancel()
{
        JRequest::checkToken() or jexit(JText::_('JInvalid_Token'));

        // Initialise variables.
        $app            = JFactory::getApplication();
        $model          = &$this->getModel();
        $table          = $model->getTable();
        $checkin        = property_exists($table, 'checked_out');
        $context        = "$this->_option.edit.$this->_context";
        $tmpl           = JRequest::getString('tmpl');
        $layout         = JRequest::getString('layout', 'edit');
        $append         = '';

        // Setup redirect info.
        if ($tmpl) {
                $append .= '&tmpl='.$tmpl;
        }
        if ($layout) {
                $append .= '&layout='.$layout;
        }

        // Get the record id.
        $recordId = (int) $app->getUserState($context.'.id');

        // Attempt to check-in the current record.
        if ($checkin && $recordId)
        {
                if(!$model->checkin($recordId))
                {
                        // Check-in failed, go back to the record and display a notice.
                        $message = JText::sprintf('JError_Checkin_failed', $model->getError());
                        $this->setRedirect('index.php?option='.$this->_option.'&view='.$this->_view_item.$append, $message, 'error');
                        return false;
                }
        }

        // Clean the session data and redirect.
        $app->setUserState($context.'.id',              null);
        $app->setUserState($context.'.data',    null);
        $this->setRedirect(JRoute::_('index.php?option='.$this->_option.'&view='.$this->_view_list, false));
}

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