class ThumbnailGenerationSettingsForm in Media PDF Thumbnail 8.3
Same name and namespace in other branches
- 8.4 src/Form/ThumbnailGenerationSettingsForm.php \Drupal\media_pdf_thumbnail\Form\ThumbnailGenerationSettingsForm
Class ThumbnailGenerationSettingsForm
@package Drupal\media_pdf_thumbnail\Form
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\media_pdf_thumbnail\Form\ThumbnailGenerationSettingsForm
Expanded class hierarchy of ThumbnailGenerationSettingsForm
1 string reference to 'ThumbnailGenerationSettingsForm'
File
- src/
Form/ ThumbnailGenerationSettingsForm.php, line 17
Namespace
Drupal\media_pdf_thumbnail\FormView 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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DependencySerializationTrait:: |
protected | property | An array of entity type IDs keyed by the property name of their storages. | |
DependencySerializationTrait:: |
protected | property | An array of service IDs keyed by property name used for serialization. | |
DependencySerializationTrait:: |
public | function | 1 | |
DependencySerializationTrait:: |
public | function | 2 | |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
FormBase:: |
protected | function | Retrieves a configuration object. | |
FormBase:: |
protected | function | Gets the config factory for this form. | 1 |
FormBase:: |
private | function | Returns the service container. | |
FormBase:: |
protected | function | Gets the current user. | |
FormBase:: |
protected | function | Gets the request object. | |
FormBase:: |
protected | function | Gets the route match. | |
FormBase:: |
protected | function | Gets the logger for a specific channel. | |
FormBase:: |
protected | function |
Returns a redirect response object for the specified route. Overrides UrlGeneratorTrait:: |
|
FormBase:: |
public | function | Resets the configuration factory. | |
FormBase:: |
public | function | Sets the config factory for this form. | |
FormBase:: |
public | function | Sets the request stack object to use. | |
LinkGeneratorTrait:: |
protected | property | The link generator. | 1 |
LinkGeneratorTrait:: |
protected | function | Returns the link generator. | |
LinkGeneratorTrait:: |
protected | function | Renders a link to a route given a route name and its parameters. | |
LinkGeneratorTrait:: |
public | function | Sets the link generator service. | |
LoggerChannelTrait:: |
protected | property | The logger channel factory service. | |
LoggerChannelTrait:: |
protected | function | Gets the logger for a specific channel. | |
LoggerChannelTrait:: |
public | function | Injects the logger channel factory. | |
MessengerTrait:: |
public | function | Gets the messenger. | 29 |
MessengerTrait:: |
public | function | Sets the messenger. | |
RedirectDestinationTrait:: |
protected | property | The redirect destination service. | 1 |
RedirectDestinationTrait:: |
protected | function | Prepares a 'destination' URL query parameter for use with \Drupal\Core\Url. | |
RedirectDestinationTrait:: |
protected | function | Returns the redirect destination service. | |
RedirectDestinationTrait:: |
public | function | Sets the redirect destination service. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 1 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
ThumbnailGenerationSettingsForm:: |
protected | property |
Overrides FormBase:: |
|
ThumbnailGenerationSettingsForm:: |
protected | property | ||
ThumbnailGenerationSettingsForm:: |
protected | property |
Overrides MessengerTrait:: |
|
ThumbnailGenerationSettingsForm:: |
public | function |
Form constructor. Overrides FormInterface:: |
|
ThumbnailGenerationSettingsForm:: |
public static | function |
Instantiates a new instance of this class. Overrides FormBase:: |
|
ThumbnailGenerationSettingsForm:: |
public static | function | Finish callback. | |
ThumbnailGenerationSettingsForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
ThumbnailGenerationSettingsForm:: |
public static | function | RegenerateThumbnails. | |
ThumbnailGenerationSettingsForm:: |
public | function |
Form submission handler. Overrides FormInterface:: |
|
ThumbnailGenerationSettingsForm:: |
public | function |
Form validation handler. Overrides FormBase:: |
|
ThumbnailGenerationSettingsForm:: |
public | function | SettingsForm constructor. | |
UrlGeneratorTrait:: |
protected | property | The url generator. | |
UrlGeneratorTrait:: |
protected | function | Returns the URL generator service. | |
UrlGeneratorTrait:: |
public | function | Sets the URL generator service. | |
UrlGeneratorTrait:: |
protected | function | Generates a URL or path for a specific route based on the given parameters. |