You are here

Home » API reference » CacheFlush 8 » CacheflushDeleteMultiple.php

class CacheflushDeleteMultiple in CacheFlush 8

Provides a cacheflush deletion confirmation form.

Hierarchy

Expanded class hierarchy of CacheflushDeleteMultiple

1 string reference to 'CacheflushDeleteMultiple'
cacheflush_ui.routing.yml in modules/cacheflush_ui/cacheflush_ui.routing.yml
modules/cacheflush_ui/cacheflush_ui.routing.yml

File

modules/cacheflush_ui/src/Form/CacheflushDeleteMultiple.php, line 18

Namespace

Drupal\cacheflush_ui\Form
View source 
class CacheflushDeleteMultiple extends ConfirmFormBase {

  /**
   * The array of cacheflush entities to delete.
   *
   * @var string[][]
   */
  protected $cacheflushInfo = [];

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

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

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

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

  /**
   * Constructs a CacheflushDeleteMultiple form object.
   *
   * @param \Drupal\Core\TempStore\PrivateTempStoreFactory $temp_store_factory
   *   The tempstore factory.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $manager
   *   The entity manager.
   * @param \Drupal\Core\Messenger\MessengerInterface $messenger
   *   The messenger service.
   * @param \Drupal\Core\Session\AccountInterface $current_user
   *   The current user account.
   */
  public function __construct(PrivateTempStoreFactory $temp_store_factory, EntityTypeManagerInterface $manager, MessengerInterface $messenger, AccountInterface $current_user) {
    $this->tempStoreFactory = $temp_store_factory;
    $this->storage = $manager
      ->getStorage('cacheflush');
    $this->messenger = $messenger;
    $this->currentUser = $current_user;
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function getQuestion() {
    return $this
      ->formatPlural(count($this->cacheflushInfo), '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.cacheflush.collection');
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $this->cacheflushInfo = $this->tempStoreFactory
      ->get('cacheflush_multiple_delete_confirm')
      ->get($this->currentUser
      ->id());
    if (empty($this->cacheflushInfo)) {
      return new RedirectResponse($this
        ->getCancelUrl()
        ->setAbsolute()
        ->toString());
    }
    $entities = $this->storage
      ->loadMultiple(array_keys($this->cacheflushInfo));
    $items = [];
    foreach ($this->cacheflushInfo 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 content 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['cacheflush_items'] = [
      '#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->cacheflushInfo)) {
      $total_count = 0;
      $delete_entities = [];
      $delete_translations = [];
      $entities = $this->storage
        ->loadMultiple(array_keys($this->cacheflushInfo));
      foreach ($this->cacheflushInfo 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('cacheflush')
          ->notice('Deleted @count cacheflush entities.', [
          '@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('cacheflush')
            ->notice('Deleted @count cacheflush translations.', [
            '@count' => $count,
          ]);
        }
      }
      if ($total_count) {
        $this->messenger
          ->addMessage($this
          ->formatPlural($total_count, 'Deleted 1 cacheflush entity.', 'Deleted @count cacheflush entities.'));
      }
      $this->tempStoreFactory
        ->get('cacheflush_multiple_delete_confirm')
        ->delete($this->currentUser
        ->id());
    }
    $form_state
      ->setRedirect('entity.cacheflush.collection');
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CacheflushDeleteMultiple::$cacheflushInfo protected property The array of cacheflush entities to delete.
CacheflushDeleteMultiple::$currentUser protected property The user account.
CacheflushDeleteMultiple::$messenger protected property The Messenger service. Overrides MessengerTrait::$messenger
CacheflushDeleteMultiple::$storage protected property The cacheflush storage.
CacheflushDeleteMultiple::$tempStoreFactory protected property The tempstore factory.
CacheflushDeleteMultiple::buildForm public function Form constructor. Overrides ConfirmFormBase::buildForm
CacheflushDeleteMultiple::create public static function Instantiates a new instance of this class. Overrides FormBase::create
CacheflushDeleteMultiple::getCancelUrl public function Returns the route to go to if the user cancels the action. Overrides ConfirmFormInterface::getCancelUrl
CacheflushDeleteMultiple::getConfirmText public function Returns a caption for the button that confirms the action. Overrides ConfirmFormBase::getConfirmText
CacheflushDeleteMultiple::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
CacheflushDeleteMultiple::getQuestion public function Returns the question to ask the user. Overrides ConfirmFormInterface::getQuestion
CacheflushDeleteMultiple::submitForm public function Form submission handler. Overrides FormInterface::submitForm
CacheflushDeleteMultiple::__construct public function Constructs a CacheflushDeleteMultiple form object.
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.
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.