abstract class ConfirmFormBase

You are here

Provides an generic base class for a confirmation form.

Namespace

Drupal\Core\Form

Hierarchy

Expanded class hierarchy of ConfirmFormBase

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
ConfirmFormBase::buildForm public function Form constructor. Overrides FormInterface::buildForm
ConfirmFormBase::getCancelText public function Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText
ConfirmFormBase::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormInterface::getConfirmText
ConfirmFormBase::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormInterface::getDescription
ConfirmFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
ConfirmFormInterface::getCancelRoute public function Returns the route to go to if the user cancels the action.
ConfirmFormInterface::getQuestion public function Returns the question to ask the user.
DependencySerialization::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerialization::__sleep public function
DependencySerialization::__wakeup public function
FormBase::$configFactory protected property The config factory.
FormBase::$errorHandler protected property The form error handler.
FormBase::$request protected property The current request.
FormBase::$translationManager protected property The translation manager service.
FormBase::$urlGenerator protected property The URL generator.
FormBase::config protected function Retrieves a configuration object.
FormBase::container private function Returns the service container.
FormBase::create public static function Instantiates a new instance of this controller. Overrides ContainerInjectionInterface::create
FormBase::currentUser protected function Gets the current user.
FormBase::errorHandler protected function Returns the form error handler.
FormBase::getRequest protected function Gets the request object.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setFormError protected function Files an error against a form element.
FormBase::setRequest public function Sets the request object to use.
FormBase::setTranslationManager public function Sets the translation manager for this form. Overrides EntityFormControllerInterface::setTranslationManager
FormBase::setUrlGenerator public function Sets the URL generator.
FormBase::t protected function Translates a string to the current language or to a given language.
FormBase::translationManager protected function Gets the translation manager.
FormBase::url public function Generates a URL or path for a specific route based on the given parameters.
FormBase::urlGenerator protected function Gets the URL generator.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm
FormInterface::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
FormInterface::submitForm public function Form submission handler.

File

core/lib/Drupal/Core/Form/ConfirmFormBase.php, line 13
Contains \Drupal\Core\Form\ConfirmFormBase.

View source
abstract class ConfirmFormBase extends FormBase implements ConfirmFormInterface {

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return t('This action cannot be undone.');
  }

  /**
   * {@inheritdoc}
   */
  public function getConfirmText() {
    return t('Confirm');
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelText() {
    return t('Cancel');
  }

  /**
   * {@inheritdoc}
   */
  public function getFormName() {
    return 'confirm';
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, array &$form_state) {
    $form['#title'] = $this->getQuestion();

    $form['#attributes']['class'][] = 'confirmation';
    $form['description'] = array('#markup' => $this->getDescription());
    $form[$this->getFormName()] = array(
      '#type' => 'hidden',
      '#value' => 1,
    );

    $form['actions'] = array('#type' => 'actions');
    $form['actions']['submit'] = array(
      '#type' => 'submit',
      '#value' => $this->getConfirmText(),
    );

    $form['actions']['cancel'] = ConfirmFormHelper::buildCancelLink($this, $this->getRequest());

    // By default, render the form using theme_confirm_form().
    if (!isset($form['#theme'])) {
      $form['#theme'] = 'confirm_form';
    }
    return $form;
  }

}
19 files declare their use of ConfirmFormBase
BanDelete.php in core/modules/ban/lib/Drupal/ban/Form/BanDelete.php
Contains \Drupal\ban\Form\BanDelete.
BookRemoveForm.php in core/modules/book/lib/Drupal/book/Form/BookRemoveForm.php
Contains \Drupal\book\Form\BookRemoveForm.
ConfigSingleImportForm.php in core/modules/config/lib/Drupal/config/Form/ConfigSingleImportForm.php
Contains \Drupal\config\Form\ConfigSingleImportForm.
ConfigTranslationDeleteForm.php in core/modules/config_translation/lib/Drupal/config_translation/Form/ConfigTranslationDeleteForm.php
Contains \Drupal\config_translation\Form\ConfigTranslationDeleteForm.
ConfirmDeleteMultiple.php in core/modules/comment/lib/Drupal/comment/Form/ConfirmDeleteMultiple.php
Contains \Drupal\comment\Form\ConfirmDeleteMultiple.

... See full list