class MediaDeleteMultipleConfirmForm in Drupal 8

Provides a confirmation form to delete multiple media items at once.

@internal

Hierarchy

class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfirmFormBase implements ConfirmFormInterface
  - class \Drupal\media\Form\MediaDeleteMultipleConfirmForm

Expanded class hierarchy of MediaDeleteMultipleConfirmForm

Deprecated

in drupal:8.6.0 and is removed from drupal:9.0.0. This route is not used in Drupal core. As an internal API, it may also be removed in a minor release. If you are using it, copy the class and the related "entity.media.multiple_delete_confirm" route to your module.

1 string reference to 'MediaDeleteMultipleConfirmForm'

media.routing.yml in core/modules/media/media.routing.yml: core/modules/media/media.routing.yml

File

core/modules/media/src/Form/MediaDeleteMultipleConfirmForm.php, line 24

Namespace

Drupal\media\Form

View source

class MediaDeleteMultipleConfirmForm extends ConfirmFormBase {

  /**
   * The array of media items to delete, indexed by ID and language.
   *
   * @var string[][]
   */
  protected $mediaItems = [];

  /**
   * The tempstore factory.
   *
   * @var \Drupal\Core\TempStore\PrivateTempStoreFactory
   */
  protected $tempStoreFactory;

  /**
   * The entity storage.
   *
   * @var \Drupal\Core\Entity\EntityStorageInterface
   */
  protected $storage;

  /**
   * Constructs a MediaDeleteMultipleConfirmForm form object.
   *
   * @param \Drupal\Core\TempStore\PrivateTempStoreFactory $temp_store_factory
   *   The tempstore factory.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $manager
   *   The entity type manager.
   */
  public function __construct(PrivateTempStoreFactory $temp_store_factory, EntityTypeManagerInterface $manager) {
    @trigger_error(__CLASS__ . ' is deprecated in Drupal 8.6.0 and will be removed before Drupal 9.0.0. It is not used in Drupal core. As an internal API, it may also be removed in a minor release. If you are using it, copy the class and the related "entity.media.multiple_delete_confirm" route to your module.', E_USER_DEPRECATED);
    $this->tempStoreFactory = $temp_store_factory;
    $this->storage = $manager
      ->getStorage('media');
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {

    // @todo Change to media library when #2834729 is done.
    // https://www.drupal.org/node/2834729.
    return new Url('system.admin_content');
  }

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

  /**
   * {@inheritdoc}
   *
   * @todo Change to trait or base class when #2843395 is done.
   * @see https://www.drupal.org/node/2843395
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $this->mediaItems = $this->tempStoreFactory
      ->get('media_multiple_delete_confirm')
      ->get($this
      ->currentUser()
      ->id());
    if (empty($this->mediaItems)) {
      return new RedirectResponse($this
        ->getCancelUrl()
        ->setAbsolute()
        ->toString());
    }

    /** @var \Drupal\media\MediaInterface[] $entities */
    $entities = $this->storage
      ->loadMultiple(array_keys($this->mediaItems));
    $items = [];
    foreach ($this->mediaItems 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,
    ];
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   *
   * @todo Change to trait or base class when #2843395 is done.
   * @see https://www.drupal.org/node/2843395
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    if ($form_state
      ->getValue('confirm') && !empty($this->mediaItems)) {
      $total_count = 0;
      $delete_entities = [];

      /** @var \Drupal\Core\Entity\ContentEntityInterface[][] $delete_translations */
      $delete_translations = [];

      /** @var \Drupal\media\MediaInterface[] $entities */
      $entities = $this->storage
        ->loadMultiple(array_keys($this->mediaItems));
      foreach ($this->mediaItems 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) {
        $this->storage
          ->delete($delete_entities);
        $this
          ->logger('media')
          ->notice('Deleted @count media items.', [
          '@count' => count($delete_entities),
        ]);
      }
      if ($delete_translations) {
        $count = 0;
        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('media')
            ->notice('Deleted @count media translations.', [
            '@count' => $count,
          ]);
        }
      }
      if ($total_count) {
        $this
          ->messenger()
          ->addStatus($this
          ->formatPlural($total_count, 'Deleted 1 media item.', 'Deleted @count media items.'));
      }
      $this->tempStoreFactory
        ->get('media_multiple_delete_confirm')
        ->delete(\Drupal::currentUser()
        ->id());
    }

    // @todo Change to media library when #2834729 is done.
    // https://www.drupal.org/node/2834729.
    $form_state
      ->setRedirect('system.admin_content');
  }

}

Members

Name	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
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.
MediaDeleteMultipleConfirmForm::$mediaItems	protected	property	The array of media items to delete, indexed by ID and language.
MediaDeleteMultipleConfirmForm::$storage	protected	property	The entity storage.
MediaDeleteMultipleConfirmForm::$tempStoreFactory	protected	property	The tempstore factory.
MediaDeleteMultipleConfirmForm::buildForm	public	function	@todo Change to trait or base class when #2843395 is done. Overrides ConfirmFormBase::buildForm
MediaDeleteMultipleConfirmForm::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create
MediaDeleteMultipleConfirmForm::getCancelUrl	public	function	Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
MediaDeleteMultipleConfirmForm::getConfirmText	public	function	Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
MediaDeleteMultipleConfirmForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
MediaDeleteMultipleConfirmForm::getQuestion	public	function	Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
MediaDeleteMultipleConfirmForm::submitForm	public	function	@todo Change to trait or base class when #2843395 is done. Overrides FormInterface::submitForm
MediaDeleteMultipleConfirmForm::__construct	public	function	Constructs a MediaDeleteMultipleConfirmForm form object.
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.

You are here