Back to FormController class

Method cancel

public bool
cancel
(mixed $key = null)
Method to cancel an edit.
Parameters
  • string $key The name of the primary key of the URL variable.
Returns
  • bool True if access level checks pass, false otherwise.
Since
  • 1.6

Method cancel - Source code

/**
 * Method to cancel an edit.
 *
 * @param   string  $key  The name of the primary key of the URL variable.
 *
 * @return  boolean  True if access level checks pass, false otherwise.
 *
 * @since   1.6
 */
public function cancel($key = null)
{
    $this->checkToken();
    $model = $this->getModel();
    $table = $model->getTable();
    $context = "{$this->option}.edit.{$this->context}";
    if (empty($key)) {
        $key = $table->getKeyName();
    }
    $recordId = $this->input->getInt($key);
    // Attempt to check-in the current record.
    if ($recordId && $table->hasField('checked_out') && $model->checkin($recordId) === false) {
        // Check-in failed, go back to the record and display a notice.
        $this->setMessage(Text::sprintf('JLIB_APPLICATION_ERROR_CHECKIN_FAILED', $model->getError()), 'error');
        $this->setRedirect(Route::_('index.php?option=' . $this->option . '&view=' . $this->view_item . $this->getRedirectToItemAppend($recordId, $key), false));
        return false;
    }
    // Clean the session data and redirect.
    $this->releaseEditId($context, $recordId);
    Factory::getApplication()->setUserState($context . '.data', null);
    $url = 'index.php?option=' . $this->option . '&view=' . $this->view_list . $this->getRedirectToListAppend();
    // Check if there is a return value
    $return = $this->input->get('return', null, 'base64');
    if (!\is_null($return) && Uri::isInternal(base64_decode($return))) {
        $url = base64_decode($return);
    }
    // Redirect to the list screen.
    $this->setRedirect(Route::_($url, false));
    return true;
}