You are here

Home » API reference » Panopoly 8.2 » FileDeleteMultiple.php

class FileDeleteMultiple in Panopoly 8.2

Provides a file deletion confirmation form.

Hierarchy

Expanded class hierarchy of FileDeleteMultiple

File

modules/panopoly/panopoly_media/src/Form/FileDeleteMultiple.php, line 18

Namespace

Drupal\panopoly_media\Form
View source 
class FileDeleteMultiple extends ConfirmFormBase {

  /**
   * The array of files to delete.
   *
   * @var array
   */
  protected $fileInfo;

  /**
   * File usage service.
   *
   * @var \Drupal\file\FileUsage\FileUsageInterface
   */
  protected $fileUsage;

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

  /**
   * The messenger service.
   *
   * @var \Drupal\Core\Messenger\MessengerInterface
   */
  protected $messenger;

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

  /**
   * Constructs a DeleteMultiple form object.
   *
   * @param \Drupal\Core\TempStore\PrivateTempStoreFactory $temp_store_factory
   *   The tempstore factory.
   * @param \Drupal\Core\Entity\EntityTypeManager $manager
   *   The entity manager.
   * @param \Drupal\file\FileUsage\FileUsageInterface $file_usage
   *   The file usage service.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The messenger service.
   */
  public function __construct(PrivateTempStoreFactory $temp_store_factory, EntityTypeManager $manager, FileUsageInterface $file_usage, MessengerInterface $messenger) {
    $this->tempStoreFactory = $temp_store_factory;
    $this->storage = $manager
      ->getStorage('file');
    $this->fileUsage = $file_usage;
    $this->messenger = $messenger;
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function getCancelUrl() {
    return Url::fromUri('internal://admin/content/files');
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $this->fileInfo = $this->tempStoreFactory
      ->get('panopoly_media_file_multiple_delete_confirm')
      ->get($this
      ->getCurrentUser()
      ->id());
    if (empty($this->fileInfo)) {
      return new RedirectResponse($this
        ->getCancelUrl()
        ->setAbsolute()
        ->toString());
    }

    /** @var \Drupal\node\NodeInterface[] $nodes */
    $files = $this->storage
      ->loadMultiple($this->fileInfo);
    if ($this
      ->filesHaveUsage($files)) {
      $form['warning'] = [
        '#theme' => 'status_messages',
        // @todo Improve when https://www.drupal.org/node/2278383 lands.
        '#message_list' => [
          'warning' => [
            $this
              ->t('One or more of these files have usages recorded. Deleting may affect content that attempts to reference these files.'),
          ],
        ],
        '#status_headings' => [
          'status' => $this
            ->t('Status message'),
          'error' => $this
            ->t('Error message'),
          'warning' => $this
            ->t('Warning message'),
        ],
      ];
    }
    $items = [];
    foreach ($this->fileInfo as $fid) {
      if (!empty($files[$fid])) {
        $items[$fid] = $files[$fid]
          ->label();
      }
    }
    $form['files'] = [
      '#theme' => 'item_list',
      '#items' => $items,
    ];
    $form = parent::buildForm($form, $form_state);
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    if ($form_state
      ->getValue('confirm') && !empty($this->fileInfo)) {
      $count = 0;
      $files = $this->storage
        ->loadMultiple($this->fileInfo);
      foreach ($this->fileInfo as $fid) {
        if (empty($files[$fid])) {
          break;
        }
        $files[$fid]
          ->delete();
        $count++;
      }
      $this
        ->logger('file')
        ->notice('Deleted @count files.', [
        '@count' => $count,
      ]);
      if ($count) {
        $this->messenger
          ->addMessage($this
          ->formatPlural($count, 'Deleted 1 file.', 'Deleted @count files.'));
      }
    }
    $form_state
      ->setRedirectUrl($this
      ->getCancelUrl());
  }

  /**
   * Determines if files have usage records.
   *
   * @param \Drupal\file\FileInterface[] $files
   *   The files to check for usage.
   *
   * @return bool
   *   Indicates if files have usage records.
   */
  protected function filesHaveUsage(array $files) {
    foreach ($files as $file) {

      /** @var \Drupal\file\FileInterface $file */
      if (!empty($this->fileUsage
        ->listUsage($file))) {
        return TRUE;
      }
    }
    return FALSE;
  }

  /**
   * Gets the current user.
   *
   * @return \Drupal\Core\Session\AccountInterface
   *   The current user.
   */
  protected function getCurrentUser() {
    return \Drupal::currentUser();
  }

}

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
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
FileDeleteMultiple::$fileInfo protected property The array of files to delete.
FileDeleteMultiple::$fileUsage protected property File usage service.
FileDeleteMultiple::$messenger protected property The messenger service. Overrides MessengerTrait::$messenger
FileDeleteMultiple::$storage protected property The node storage.
FileDeleteMultiple::$tempStoreFactory protected property The tempstore factory.
FileDeleteMultiple::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
FileDeleteMultiple::create public static function Instantiates a new instance of this class. Overrides FormBase::create
FileDeleteMultiple::filesHaveUsage protected function Determines if files have usage records.
FileDeleteMultiple::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
FileDeleteMultiple::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
FileDeleteMultiple::getCurrentUser protected function Gets the current user.
FileDeleteMultiple::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
FileDeleteMultiple::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
FileDeleteMultiple::submitForm public function Form submission handler. Overrides FormInterface::submitForm
FileDeleteMultiple::__construct public function Constructs a DeleteMultiple form object.
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.