You are here

class ThumbnailGenerationSettingsForm in Media PDF Thumbnail 8.3

Same name and namespace in other branches
  1. 8.4 src/Form/ThumbnailGenerationSettingsForm.php \Drupal\media_pdf_thumbnail\Form\ThumbnailGenerationSettingsForm

Class ThumbnailGenerationSettingsForm

@package Drupal\media_pdf_thumbnail\Form

Hierarchy

Expanded class hierarchy of ThumbnailGenerationSettingsForm

1 string reference to 'ThumbnailGenerationSettingsForm'
media_pdf_thumbnail.routing.yml in ./media_pdf_thumbnail.routing.yml
media_pdf_thumbnail.routing.yml

File

src/Form/ThumbnailGenerationSettingsForm.php, line 17

Namespace

Drupal\media_pdf_thumbnail\Form
View source
class ThumbnailGenerationSettingsForm extends FormBase {

  /**
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * @var \Drupal\Core\Messenger\Messenger
   */
  protected $messenger;

  /**
   * @var \Drupal\Core\Config\ConfigFactory
   */
  protected $configFactory;

  /**
   * SettingsForm constructor.
   *
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entityTypeManager
   * @param \Drupal\Core\Messenger\Messenger $messenger
   * @param \Drupal\Core\Config\ConfigFactory $configFactory
   */
  public function __construct(EntityTypeManagerInterface $entityTypeManager, Messenger $messenger, ConfigFactory $configFactory) {
    $this->entityTypeManager = $entityTypeManager;
    $this->messenger = $messenger;
    $this->configFactory = $configFactory;
  }

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

  /**
   * RegenerateThumbnails.
   *
   * @param $mid
   *
   * @param $context
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   * @throws \Drupal\Core\Entity\EntityStorageException
   */
  public static function regenerateThumbnail($mid, &$context) {
    $media = \Drupal::entityTypeManager()
      ->getStorage('media')
      ->load($mid);
    $media
      ->save();
    $context['message'] = 'Processing - ' . $media
      ->label();
    $context['results'][] = $media
      ->label();
  }

  /**
   * Finish callback.
   *
   * @param mixed $success
   *   Success.
   * @param mixed $results
   *   Results.
   * @param mixed $operations
   *   Operations.
   */
  public static function finishedCallback($success, $results, $operations) {
    if ($success) {
      $message = \Drupal::translation()
        ->formatPlural(count($results), 'One task processed.', '@count tasks processed.');
      \Drupal::messenger()
        ->addMessage($message);
    }
    else {
      \Drupal::messenger()
        ->addError(t('Finished with an error.'));
    }
  }

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Regenerate thumbnails'),
      '#description' => $this
        ->t('Regenerate thumbnail images for all media entities.'),
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $data = $this->configFactory
      ->get('media_pdf_thumbnail.bundles.settings')
      ->getRawData();
    $bundles = [];
    foreach ($data as $name => $item) {
      $bundle = substr($name, 0, strpos($name, '_field'));
      if (!empty($data[$bundle . '_enable'])) {
        $bundles[] = $bundle;
      }
    }
    if (empty($bundles)) {
      return;
    }
    $mids = $this->entityTypeManager
      ->getStorage('media')
      ->getQuery()
      ->condition('bundle', $bundles, 'IN')
      ->execute();
    $operations = [];
    foreach ($mids as $mid) {
      $operations[] = [
        'Drupal\\media_pdf_thumbnail\\Form\\settingsForm::regenerateThumbnail',
        [
          $mid,
        ],
      ];
    }
    $batch = [
      'title' => t('Regenerates media thumbnails'),
      'operations' => $operations,
      'init_message' => t('Thumbnail creating process is starting.'),
      'progress_message' => t('Processed @current out of @total. Estimated time: @estimate.'),
      'error_message' => t('An error occurred during processing'),
      'finished' => '\\Drupal\\media_pdf_thumbnail\\Form\\settingsForm::finishedCallback',
    ];
    $batch['operations'] = batch_set($batch);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::$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.
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.
ThumbnailGenerationSettingsForm::$configFactory protected property Overrides FormBase::$configFactory
ThumbnailGenerationSettingsForm::$entityTypeManager protected property
ThumbnailGenerationSettingsForm::$messenger protected property Overrides MessengerTrait::$messenger
ThumbnailGenerationSettingsForm::buildForm public function Form constructor. Overrides FormInterface::buildForm
ThumbnailGenerationSettingsForm::create public static function Instantiates a new instance of this class. Overrides FormBase::create
ThumbnailGenerationSettingsForm::finishedCallback public static function Finish callback.
ThumbnailGenerationSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
ThumbnailGenerationSettingsForm::regenerateThumbnail public static function RegenerateThumbnails.
ThumbnailGenerationSettingsForm::submitForm public function Form submission handler. Overrides FormInterface::submitForm
ThumbnailGenerationSettingsForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
ThumbnailGenerationSettingsForm::__construct public function SettingsForm constructor.
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.