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

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

Hierarchy

Expanded class hierarchy of ContentEntityConfirmFormBase

1 file declares its use of ContentEntityConfirmFormBase
UserCancelForm.php in core/modules/user/src/Form/UserCancelForm.php

File

core/lib/Drupal/Core/Entity/ContentEntityConfirmFormBase.php, line 12

Namespace

Drupal\Core\Entity
View source
abstract class ContentEntityConfirmFormBase extends ContentEntityForm 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}
   */
  public function form(array $form, FormStateInterface $form_state) {

    // Do not attach fields to the 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 ContentEntityConfirmFormBase. 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 ContentEntityConfirmFormBase. 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) {
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {

    // Override the default validation implementation as it is not necessary
    // nor possible to validate an entity in a confirmation form.
    return $this->entity;
  }

}

Members

Name Modifierssort descending Type Description Overrides
FormBase::container private function Returns the service container.
ContentEntityConfirmFormBase::actions protected function Returns an array of supported actions for the current entity form. Overrides EntityForm::actions
ContentEntityForm::prepareEntity protected function Prepares the entity object before the form is built first. Overrides EntityForm::prepareEntity 1
ContentEntityForm::getBundleEntity protected function Returns the bundle entity of the entity, or NULL if there is none.
ContentEntityForm::getEditedFieldNames protected function Gets the names of all fields edited in the form.
ContentEntityForm::flagViolations protected function Flags violations for the current form.
ContentEntityForm::init protected function Initializes the form state and the entity before the first form build. Overrides EntityForm::init 1
ContentEntityForm::initFormLangcodes protected function Initializes form language code values.
ContentEntityForm::copyFormValuesToEntity protected function Copies top-level form values to entity properties. Overrides EntityForm::copyFormValuesToEntity
ContentEntityForm::addRevisionableFormFields protected function Add revision form fields if the entity enabled the UI.
ContentEntityForm::getNewRevisionDefault protected function Should new revisions created on default.
ContentEntityForm::showRevisionUi protected function Checks whether the revision form fields should be added to the form.
EntityForm::actionsElement protected function Returns the action form element for the current entity form.
EntityForm::prepareInvokeAll protected function Invokes the specified prepare hook variant.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 2
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::currentUser protected function Gets the current user.
FormBase::redirect protected function Returns a redirect response object for the specified route.
FormBase::logger protected function Gets the logger for a specific channel.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
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.
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.
ContentEntityForm::$entity protected property The entity being used by this form. Overrides EntityForm::$entity 7
ContentEntityForm::$entityTypeBundleInfo protected property The entity type bundle info service.
ContentEntityForm::$time protected property The time service.
ContentEntityForm::$entityRepository protected property The entity repository service.
EntityForm::$operation protected property The name of the current operation.
EntityForm::$moduleHandler protected property The module handler service. 2
EntityForm::$entityTypeManager protected property The entity type manager. 3
FormBase::$requestStack protected property The request stack. 1
FormBase::$configFactory protected property The config factory. 2
FormBase::$routeMatch protected property The route match.
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::$_entityStorages protected property
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
MessengerTrait::$messenger protected property The messenger. 8
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
ContentEntityConfirmFormBase::getBaseFormId public function Returns a string identifying the base form. Overrides EntityForm::getBaseFormId
ContentEntityConfirmFormBase::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormInterface::getDescription 5
ContentEntityConfirmFormBase::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormInterface::getConfirmText 1
ContentEntityConfirmFormBase::getCancelText public function Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText
ContentEntityConfirmFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
ContentEntityConfirmFormBase::buildForm public function Form constructor. Overrides EntityForm::buildForm 2
ContentEntityConfirmFormBase::form public function Gets the actual form array to be built. Overrides ContentEntityForm::form
ContentEntityConfirmFormBase::save public function The save() method is not used in ContentEntityConfirmFormBase. This overrides the default implementation that saves the entity. Overrides EntityForm::save
ContentEntityConfirmFormBase::delete public function The delete() method is not used in ContentEntityConfirmFormBase. This overrides the default implementation that redirects to the delete-form confirmation form.
ContentEntityConfirmFormBase::validateForm public function Button-level validation handlers are highly discouraged for entity forms, as they will prevent entity validation from running. If the entity is going to be saved during the form submission, this method should be manually invoked from the button-level… Overrides ContentEntityForm::validateForm
ContentEntityForm::__construct public function Constructs a ContentEntityForm object. 5
ContentEntityForm::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 EntityForm::submitForm 2
ContentEntityForm::buildEntity public function Builds an updated entity object based upon the submitted form values. Overrides EntityForm::buildEntity
ContentEntityForm::getFormLangcode public function Gets the code identifying the active form language. Overrides ContentEntityFormInterface::getFormLangcode
ContentEntityForm::isDefaultFormLangcode public function Checks whether the current form language matches the entity one. Overrides ContentEntityFormInterface::isDefaultFormLangcode
ContentEntityForm::getFormDisplay public function Gets the form display. Overrides ContentEntityFormInterface::getFormDisplay
ContentEntityForm::setFormDisplay public function Sets the form display. Overrides ContentEntityFormInterface::setFormDisplay
ContentEntityForm::updateFormLangcode public function Updates the form language to reflect any change to the entity language.
ContentEntityForm::updateChangedTime public function Updates the changed time of the entity.
EntityForm::setOperation public function Sets the operation for this form. Overrides EntityFormInterface::setOperation
EntityForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId 12
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::getEntity public function Gets the form entity. Overrides EntityFormInterface::getEntity
EntityForm::setEntity public function Sets the form entity. Overrides EntityFormInterface::setEntity
EntityForm::getEntityFromRouteMatch public function Determines which entity will be used by this form from a RouteMatch object. Overrides EntityFormInterface::getEntityFromRouteMatch 1
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::setConfigFactory public function Sets the config factory for this form.
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setRequestStack public function Sets the request stack object to use.
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::setMessenger public function Sets the messenger.
MessengerTrait::messenger public function Gets the messenger. 8
RedirectDestinationTrait::setRedirectDestination public function Sets the redirect destination service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 1
ConfirmFormInterface::getQuestion public function Returns the question to ask the user. 38
ConfirmFormInterface::getCancelUrl public function Returns the route to go to if the user cancels the action. 37
ContentEntityForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create 5