You are here

Home » API reference » Webform 8.5 » WebformDeleteMultipleFormBase.php

abstract class WebformDeleteMultipleFormBase in Webform 8.5

Same name and namespace in other branches
  1. 6.x src/Form/WebformDeleteMultipleFormBase.php \Drupal\webform\Form\WebformDeleteMultipleFormBase

Provides an entities deletion confirmation form.

Hierarchy

Expanded class hierarchy of WebformDeleteMultipleFormBase

See also

\Drupal\Core\Entity\Form\DeleteMultipleForm

\Drupal\webform\Form\WebformDeleteFormInterface

\Drupal\webform\Form\WebformConfigEntityDeleteFormBase

File

src/Form/WebformDeleteMultipleFormBase.php, line 16

Namespace

Drupal\webform\Form
View source 
abstract class WebformDeleteMultipleFormBase extends DeleteMultipleForm {

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state, $entity_type_id = NULL) {

    // Issue #2582295: Confirmation cancel links are incorrect if installed in
    // a subdirectory
    // Work-around: Remove subdirectory from destination before generating
    // actions.
    $request = $this
      ->getRequest();
    $destination = $request->query
      ->get('destination');
    if ($destination) {

      // Remove subdirectory from destination.
      $update_destination = preg_replace('/^' . preg_quote(base_path(), '/') . '/', '/', $destination);
      $request->query
        ->set('destination', $update_destination);
      $form = parent::buildForm($form, $form_state, $entity_type_id);
      $request->query
        ->set('destination', $destination);
    }
    else {
      $form = parent::buildForm($form, $form_state, $entity_type_id);
    }

    // Exit if redirect.
    if ($form instanceof RedirectResponse) {
      return $form;
    }
    $form['message'] = $this
      ->getWarning();
    $form['entities'] += [
      '#prefix' => $this
        ->formatPlural(count($this->selection), 'The below @item will be deleted.', 'The below @items will be deleted.', [
        '@item' => $this->entityType
          ->getSingularLabel(),
        '@items' => $this->entityType
          ->getPluralLabel(),
      ]),
      '#suffix' => '<p><hr/></p>',
    ];
    $form['description'] = $this
      ->getDescription();
    $form['hr'] = [
      '#markup' => '<p><hr/></p>',
    ];
    $form['confirm_input'] = $this
      ->getConfirmInput();
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->formatPlural(count($this->selection), 'Delete this @item?', 'Delete these @items?', [
      '@item' => $this->entityType
        ->getSingularLabel(),
      '@items' => $this->entityType
        ->getPluralLabel(),
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return [];
  }

  /**
   * Returns warning message to display.
   *
   */
  public function getWarning() {
    $message = $this
      ->formatPlural(count($this->selection), 'Are you sure you want to delete this @item?', 'Are you sure you want to delete these @items?', [
      '@item' => $this->entityType
        ->getSingularLabel(),
      '@items' => $this->entityType
        ->getPluralLabel(),
    ]);
    return [
      '#type' => 'webform_message',
      '#message_type' => 'warning',
      '#message_message' => $message,
      '#weight' => -10,
    ];
  }

  /**
   * Returns confirm input to display.
   *
   * @return array
   *   A renderable array containing confirm input.
   */
  public function getConfirmInput() {
    return [
      '#type' => 'checkbox',
      '#title' => $this
        ->formatPlural(count($this->selection), 'Yes, I want to delete this @item?', 'Yes, I want to delete these @items?', [
        '@item' => $this->entityType
          ->getSingularLabel(),
        '@items' => $this->entityType
          ->getPluralLabel(),
      ]),
      '#required' => TRUE,
    ];
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfirmFormBase::getCancelText public function Returns a caption for the link which cancels the action. Overrides ConfirmFormInterface::getCancelText 1
ConfirmFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
DeleteMultipleForm::$currentUser protected property The current user.
DeleteMultipleForm::$entityType protected property The entity type definition.
DeleteMultipleForm::$entityTypeId protected property The entity type ID.
DeleteMultipleForm::$entityTypeManager protected property The entity type manager.
DeleteMultipleForm::$messenger protected property The messenger service. Overrides MessengerTrait::$messenger
DeleteMultipleForm::$selection protected property The selection, in the entity_id => langcodes format.
DeleteMultipleForm::$tempStore protected property The tempstore.
DeleteMultipleForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
DeleteMultipleForm::getBaseFormId public function Returns a string identifying the base form. Overrides BaseFormIdInterface::getBaseFormId
DeleteMultipleForm::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl 2
DeleteMultipleForm::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
DeleteMultipleForm::getDeletedMessage protected function Returns the message to show the user after an item was deleted. 2
DeleteMultipleForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
DeleteMultipleForm::getInaccessibleMessage protected function Returns the message to show the user when an item has not been deleted. 2
DeleteMultipleForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
DeleteMultipleForm::__construct public function Constructs a new DeleteMultiple object.
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormBase::$configFactory protected property The config factory. 1
FormBase::$requestStack protected property The request stack. 1
FormBase::$routeMatch protected property The route match.
FormBase::config protected function Retrieves a configuration object.
FormBase::configFactory protected function Gets the config factory for this form. 1
FormBase::container private function Returns the service container.
FormBase::currentUser protected function Gets the current user.
FormBase::getRequest protected function Gets the request object.
FormBase::getRouteMatch protected function Gets the route match.
FormBase::logger protected function Gets the logger for a specific channel.
FormBase::redirect protected function Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait::redirect
FormBase::resetConfigFactory public function Resets the configuration factory.
FormBase::setConfigFactory public function Sets the config factory for this form.
FormBase::setRequestStack public function Sets the request stack object to use.
FormBase::validateForm public function Form validation handler. Overrides FormInterface::validateForm 62
LinkGeneratorTrait::$linkGenerator protected property The link generator. 1
LinkGeneratorTrait::getLinkGenerator Deprecated protected function Returns the link generator.
LinkGeneratorTrait::l Deprecated protected function Renders a link to a route given a route name and its parameters.
LinkGeneratorTrait::setLinkGenerator Deprecated public function Sets the link generator service.
LoggerChannelTrait::$loggerFactory protected property The logger channel factory service.
LoggerChannelTrait::getLogger protected function Gets the logger for a specific channel.
LoggerChannelTrait::setLoggerFactory public function Injects the logger channel factory.
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
RedirectDestinationTrait::$redirectDestination protected property The redirect destination service. 1
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::$stringTranslation protected property The string translation service. 1
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.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.
UrlGeneratorTrait::$urlGenerator protected property The url generator.
UrlGeneratorTrait::getUrlGenerator Deprecated protected function Returns the URL generator service.
UrlGeneratorTrait::setUrlGenerator Deprecated public function Sets the URL generator service.
UrlGeneratorTrait::url Deprecated protected function Generates a URL or path for a specific route based on the given parameters.
WebformDeleteMultipleFormBase::buildForm public function Form constructor. Overrides DeleteMultipleForm::buildForm
WebformDeleteMultipleFormBase::getConfirmInput public function Returns confirm input to display.
WebformDeleteMultipleFormBase::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormBase::getDescription 2
WebformDeleteMultipleFormBase::getQuestion public function Returns the question to ask the user. Overrides DeleteMultipleForm::getQuestion
WebformDeleteMultipleFormBase::getWarning public function Returns warning message to display.