You are here

Home » API reference » Entity API 8.0 » DeleteMultiple.php

class DeleteMultiple in Entity API 8.0

Provides an entities deletion confirmation form.

Hierarchy

Expanded class hierarchy of DeleteMultiple

File

src/Form/DeleteMultiple.php, line 22
Contains \Drupal\entity\Form\DeleteMultiple.

Namespace

Drupal\entity\Form
View source 
class DeleteMultiple extends ConfirmFormBase {

  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $currentUser;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * The tempstore.
   *
   * @var \Drupal\user\SharedTempStore
   */
  protected $tempStore;

  /**
   * The entity type id.
   *
   * @var string
   */
  protected $entityTypeId;

  /**
   * The selection, in the entity_id => langcodes format.
   *
   * @var array
   */
  protected $selection = [];

  /**
   * Constructs a new DeleteMultiple object.
   *
   * @param \Drupal\Core\Session\AccountInterface $current_user
   *   The current user.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\user\PrivateTempStoreFactory $temp_store_factory
   *   The tempstore factory.
   */
  public function __construct(AccountInterface $current_user, EntityTypeManagerInterface $entity_type_manager, PrivateTempStoreFactory $temp_store_factory) {
    $this->currentUser = $current_user;
    $this->entityTypeManager = $entity_type_manager;
    $this->tempStore = $temp_store_factory
      ->get('entity_delete_multiple_confirm');
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('current_user'), $container
      ->get('entity_type.manager'), $container
      ->get('user.private_tempstore'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'entity_delete_multiple_confirm';
  }

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->formatPlural(count($this->selection), 'Are you sure you want to delete this item?', 'Are you sure you want to delete these items?');
  }

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return new Url('entity.' . $this->entityTypeId . '.collection');
  }

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

  /**
   * {@inheritdoc}
   *
   * @param string $entity_type_id
   *   The entity type id.
   */
  public function buildForm(array $form, FormStateInterface $form_state, $entity_type_id = NULL) {
    $this->entityTypeId = $entity_type_id;
    $this->selection = $this->tempStore
      ->get($this->currentUser
      ->id());
    if (empty($this->entityTypeId) || empty($this->selection)) {
      return new RedirectResponse($this
        ->getCancelUrl()
        ->setAbsolute()
        ->toString());
    }
    $storage = $this->entityTypeManager
      ->getStorage($this->entityTypeId);

    /** @var \Drupal\Core\Entity\ContentEntityInterface[] $entities */
    $entities = $storage
      ->loadMultiple(array_keys($this->selection));
    $items = [];
    foreach ($this->selection as $id => $langcodes) {
      foreach ($langcodes as $langcode) {
        $entity = $entities[$id]
          ->getTranslation($langcode);
        $key = $id . ':' . $langcode;
        $default_key = $id . ':' . $entity
          ->getUntranslated()
          ->language()
          ->getId();

        // If we have a translated entity we build a nested list of translations
        // that will be deleted.
        $languages = $entity
          ->getTranslationLanguages();
        if (count($languages) > 1 && $entity
          ->isDefaultTranslation()) {
          $names = [];
          foreach ($languages as $translation_langcode => $language) {
            $names[] = $language
              ->getName();
            unset($items[$id . ':' . $translation_langcode]);
          }
          $items[$default_key] = [
            'label' => [
              '#markup' => $this
                ->t('@label (Original translation) - <em>The following translations will be deleted:</em>', [
                '@label' => $entity
                  ->label(),
              ]),
            ],
            'deleted_translations' => [
              '#theme' => 'item_list',
              '#items' => $names,
            ],
          ];
        }
        elseif (!isset($items[$default_key])) {
          $items[$key] = $entity
            ->label();
        }
      }
    }
    $form['entities'] = [
      '#theme' => 'item_list',
      '#items' => $items,
    ];
    $form = parent::buildForm($form, $form_state);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $total_count = 0;
    $delete_entities = [];
    $delete_translations = [];
    $storage = $this->entityTypeManager
      ->getStorage($this->entityTypeId);

    /** @var \Drupal\Core\Entity\ContentEntityInterface[] $entities */
    $entities = $storage
      ->loadMultiple(array_keys($this->selection));
    foreach ($this->selection as $id => $langcodes) {
      foreach ($langcodes as $langcode) {
        $entity = $entities[$id]
          ->getTranslation($langcode);
        if ($entity
          ->isDefaultTranslation()) {
          $delete_entities[$id] = $entity;
          unset($delete_translations[$id]);
          $total_count += count($entity
            ->getTranslationLanguages());
        }
        elseif (!isset($delete_entities[$id])) {
          $delete_translations[$id][] = $entity;
        }
      }
    }
    if ($delete_entities) {
      $storage
        ->delete($delete_entities);
      $this
        ->logger('content')
        ->notice('Deleted @count @entity_type items.', [
        '@count' => count($delete_entities),
        '@entity_type' => $this->entityTypeId,
      ]);
    }
    if ($delete_translations) {
      $count = 0;

      /** @var \Drupal\Core\Entity\ContentEntityInterface[][] $delete_translations */
      foreach ($delete_translations as $id => $translations) {
        $entity = $entities[$id]
          ->getUntranslated();
        foreach ($translations as $translation) {
          $entity
            ->removeTranslation($translation
            ->language()
            ->getId());
        }
        $entity
          ->save();
        $count += count($translations);
      }
      if ($count) {
        $total_count += $count;
        $this
          ->logger('content')
          ->notice('Deleted @count @entity_type translations.', [
          '@count' => $count,
          '@entity_type' => $this->entityTypeId,
        ]);
      }
    }
    if ($total_count) {
      drupal_set_message($this
        ->formatPlural($total_count, 'Deleted 1 item.', 'Deleted @count items.'));
    }
    $this->tempStore
      ->delete($this->currentUser
      ->id());
    $form_state
      ->setRedirectUrl($this
      ->getCancelUrl());
  }

}

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::getDescription public function Returns additional text to display as a description. Overrides ConfirmFormInterface::getDescription 11
ConfirmFormBase::getFormName public function Returns the internal name used to refer to the confirmation item. Overrides ConfirmFormInterface::getFormName
DeleteMultiple::$currentUser protected property The current user.
DeleteMultiple::$entityTypeId protected property The entity type id.
DeleteMultiple::$entityTypeManager protected property The entity type manager.
DeleteMultiple::$selection protected property The selection, in the entity_id => langcodes format.
DeleteMultiple::$tempStore protected property The tempstore.
DeleteMultiple::buildForm public function Overrides ConfirmFormBase::buildForm
DeleteMultiple::create public static function Instantiates a new instance of this class. Overrides FormBase::create
DeleteMultiple::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
DeleteMultiple::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
DeleteMultiple::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
DeleteMultiple::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
DeleteMultiple::submitForm public function Form submission handler. Overrides FormInterface::submitForm
DeleteMultiple::__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 protected property The messenger. 29
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.