Same name and namespace in other branches
  1. 8.9.x core/lib/Drupal/Core/Entity/EntityConfirmFormBase.php \Drupal\Core\Entity\EntityConfirmFormBase
  2. 9 core/lib/Drupal/Core/Entity/EntityConfirmFormBase.php \Drupal\Core\Entity\EntityConfirmFormBase

Provides a generic base class for an entity-based confirmation form.

Hierarchy

Expanded class hierarchy of EntityConfirmFormBase

Related topics

6 files declare their use of EntityConfirmFormBase
BreakLockForm.php in core/modules/views_ui/src/Form/BreakLockForm.php
FilterDisableForm.php in core/modules/filter/src/Form/FilterDisableForm.php
ImageStyleFlushForm.php in core/modules/image/src/Form/ImageStyleFlushForm.php
VocabularyResetForm.php in core/modules/taxonomy/src/Form/VocabularyResetForm.php
WorkflowDeleteForm.php in core/modules/workflows/src/Form/WorkflowDeleteForm.php

... See full list

File

core/lib/Drupal/Core/Entity/EntityConfirmFormBase.php, line 14

Namespace

Drupal\Core\Entity
View source
abstract class EntityConfirmFormBase extends EntityForm implements ConfirmFormInterface {

  /**
   * {@inheritdoc}
   */
  public function getBaseFormId() {
    return $this->entity
      ->getEntityTypeId() . '_confirm_form';
  }

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

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

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = parent::buildForm($form, $form_state);
    $form['#title'] = $this
      ->getQuestion();
    $form['#attributes']['class'][] = 'confirmation';
    $form['description'] = [
      '#markup' => $this
        ->getDescription(),
    ];
    $form[$this
      ->getFormName()] = [
      '#type' => 'hidden',
      '#value' => 1,
    ];

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

  /**
   * {@inheritdoc}
   */
  protected function actions(array $form, FormStateInterface $form_state) {
    return [
      'submit' => [
        '#type' => 'submit',
        '#value' => $this
          ->getConfirmText(),
        '#submit' => [
          [
            $this,
            'submitForm',
          ],
        ],
      ],
      'cancel' => ConfirmFormHelper::buildCancelLink($this, $this
        ->getRequest()),
    ];
  }

  /**
   * {@inheritdoc}
   *
   * The save() method is not used in EntityConfirmFormBase. This overrides the
   * default implementation that saves the entity.
   *
   * Confirmation forms should override submitForm() instead for their logic.
   */
  public function save(array $form, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   *
   * The delete() method is not used in EntityConfirmFormBase. This overrides
   * the default implementation that redirects to the delete-form confirmation
   * form.
   *
   * Confirmation forms should override submitForm() instead for their logic.
   */
  public function delete(array $form, FormStateInterface $form_state) {
  }

}

Members

Name Modifiers Type Description Overridessort ascending
FormBase::create public static function Instantiates a new instance of this class. Overrides ContainerInjectionInterface::create 85
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 47
ConfirmFormInterface::getQuestion public function Returns the question to ask the user. 37
ConfirmFormInterface::getCancelUrl public function Returns the route to go to if the user cancels the action. 36
EntityForm::form public function Gets the actual form array to be built. 29
EntityForm::submitForm public function This is the default entity object builder function. It is called before any other submit handler to build the new entity object to be used by the following submit handlers. At this point of the form workflow the entity is validated and the form stateā€¦ Overrides FormInterface::submitForm 15
EntityForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId 12
EntityConfirmFormBase::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormInterface::getDescription 11
EntityForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties. 9
MessengerTrait::messenger public function Gets the messenger. 8
EntityForm::$entity protected property The entity being used by this form. 8
MessengerTrait::$messenger protected property The messenger. 8
EntityConfirmFormBase::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormInterface::getConfirmText 5
EntityConfirmFormBase::buildForm public function Form constructor. Overrides EntityForm::buildForm 4
EntityForm::buildEntity public function Builds an updated entity object based upon the submitted form values. Overrides EntityFormInterface::buildEntity 4
EntityForm::$entityTypeManager protected property The entity type manager. 3
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
EntityForm::init protected function Initialize the form state and the entity before the first form build. 2
EntityForm::prepareEntity protected function Prepares the entity object before the form is built first. 2
FormBase::configFactory protected function Gets the config factory for this form. 2
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
EntityForm::$moduleHandler protected property The module handler service. 2
FormBase::$configFactory protected property The config factory. 2
EntityConfirmFormBase::actions protected function Returns an array of supported actions for the current entity form. Overrides EntityForm::actions 1
EntityForm::getEntityFromRouteMatch public function Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface::getEntityFromRouteMatch 1
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 1
FormBase::$requestStack protected property The request stack. 1
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
EntityConfirmFormBase::getBaseFormId public function Returns a string identifying the base form. Overrides EntityForm::getBaseFormId
EntityConfirmFormBase::getCancelText public function Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText
EntityConfirmFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
EntityConfirmFormBase::save public function The save() method is not used in EntityConfirmFormBase. This overrides the default implementation that saves the entity. Overrides EntityForm::save
EntityConfirmFormBase::delete public function The delete() method is not used in EntityConfirmFormBase. This overrides the default implementation that redirects to the delete-form confirmation form.
EntityForm::setOperation public function Sets the operation for this form. Overrides EntityFormInterface::setOperation
EntityForm::processForm public function Process callback: assigns weights and hides extra fields.
EntityForm::afterBuild public function Form element #after_build callback: Updates the entity with submitted data.
EntityForm::actionsElement protected function Returns the action form element for the current entity form.
EntityForm::getEntity public function Gets the form entity. Overrides EntityFormInterface::getEntity
EntityForm::setEntity public function Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::prepareInvokeAll protected function Invokes the specified prepare hook variant.
EntityForm::getOperation public function Gets the operation identifying the form. Overrides EntityFormInterface::getOperation
EntityForm::setModuleHandler public function Sets the module handler for this form. Overrides EntityFormInterface::setModuleHandler
EntityForm::setEntityTypeManager public function Sets the entity type manager for this form. Overrides EntityFormInterface::setEntityTypeManager
FormBase::config protected function Retrieves a configuration object.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::currentUser protected function Gets the current user.
FormBase::redirect protected function Returns a redirect response object for the specified route.
FormBase::container private function Returns the service container.
FormBase::logger protected function Gets the logger for a specific channel.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::getDestinationArray protected function Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url.
RedirectDestinationTrait::getRedirectDestination protected function Returns the redirect destination service.
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
EntityForm::$operation protected property The name of the current operation.
FormBase::$routeMatch protected property The route match.
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::$_entityStorages protected property
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.