class BundlesSettingsForm in Media PDF Thumbnail 8.4
Same name and namespace in other branches
- 8.3 src/Form/BundlesSettingsForm.php \Drupal\media_pdf_thumbnail\Form\BundlesSettingsForm
Configure example settings for this site.
Hierarchy
- class \Drupal\Core\Form\FormBase implements ContainerInjectionInterface, FormInterface uses DependencySerializationTrait, LoggerChannelTrait, MessengerTrait, LinkGeneratorTrait, RedirectDestinationTrait, UrlGeneratorTrait, StringTranslationTrait
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
- class \Drupal\media_pdf_thumbnail\Form\BundlesSettingsForm
- class \Drupal\Core\Form\ConfigFormBase uses ConfigFormBaseTrait
Expanded class hierarchy of BundlesSettingsForm
5 files declare their use of BundlesSettingsForm
- MediaPdfThumbnailFieldFormatter.php in src/
Plugin/ Field/ FieldFormatter/ MediaPdfThumbnailFieldFormatter.php - MediaPdfThumbnailImageFieldFormatter.php in src/
Plugin/ Field/ FieldFormatter/ MediaPdfThumbnailImageFieldFormatter.php - MediaPdfThumbnailQueueManager.php in src/
Manager/ MediaPdfThumbnailQueueManager.php - MediaPdfThumbnailService.php in src/
Service/ MediaPdfThumbnailService.php - media_pdf_thumbnail.module in ./
media_pdf_thumbnail.module - Contains media_pdf_thumbnail.module.
1 string reference to 'BundlesSettingsForm'
File
- src/
Form/ BundlesSettingsForm.php, line 15
Namespace
Drupal\media_pdf_thumbnail\FormView source
class BundlesSettingsForm extends ConfigFormBase {
/**
* Config settings.
*
* @var string
*/
const SETTINGS = 'media_pdf_thumbnail.bundles.settings';
/**
* @var \Drupal\Core\Entity\EntityTypeBundleInfo
*/
protected $entityTypeBundleInfo;
/**
* @var \Drupal\Core\Entity\EntityFieldManager
*/
protected $entityFieldManager;
/**
* BundlesSettingsForm constructor.
*
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
* @param \Drupal\Core\Entity\EntityTypeBundleInfo $entityTypeBundleInfo
* @param \Drupal\Core\Entity\EntityFieldManager $entityFieldManager
*/
public function __construct(ConfigFactoryInterface $config_factory, EntityTypeBundleInfo $entityTypeBundleInfo, EntityFieldManager $entityFieldManager) {
parent::__construct($config_factory);
$this->entityTypeBundleInfo = $entityTypeBundleInfo;
$this->entityFieldManager = $entityFieldManager;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container) {
return new static($container
->get('config.factory'), $container
->get('entity_type.bundle.info'), $container
->get('entity_field.manager'));
}
/**
* {@inheritdoc}
*/
public function getFormId() {
return 'bundles_settings_form';
}
/**
* {@inheritdoc}
*/
public function buildForm(array $form, FormStateInterface $form_state) {
$config = $this
->config(static::SETTINGS);
foreach ($this
->getFieldsList() as $bundleId => $infos) {
if (!empty($infos['fields'])) {
$form[$bundleId] = [
'#type' => 'fieldset',
'#title' => t($infos['label']),
'#collapsible' => FALSE,
'#collapsed' => FALSE,
];
$form[$bundleId][$bundleId . '_field'] = [
'#type' => 'select',
'#title' => $this
->t('Field to use to generate thumbnail'),
'#description' => $this
->t('The file attached must be pdf type, otherwise it will be ignored.</br>If that field is multivalued, only the first value will be used.'),
'#options' => $infos['fields'],
'#default_value' => $config
->get($bundleId . '_field'),
];
$form[$bundleId][$bundleId . '_enable'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Enable'),
'#default_value' => $config
->get($bundleId . '_enable'),
];
}
}
$form['cron'] = [
'#type' => 'fieldset',
'#title' => t('CRON'),
'#collapsible' => FALSE,
'#collapsed' => FALSE,
];
$form['cron']['cron_enable'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Enable cron'),
'#default_value' => $config
->get('cron_enable'),
'#description' => $this
->t('If enabled, thumbnails process will be added in a separate queue for being generated in cron task.'),
];
$form['cron']['cron_time'] = [
'#type' => 'number',
'#title' => $this
->t('Minutes'),
'#default_value' => $config
->get('cron_time'),
'#description' => $this
->t('Default value is 1 minute'),
'#min' => 1,
];
return parent::buildForm($form, $form_state);
}
/**
* @return array
*/
protected function getFieldsList() {
$bundles = $this->entityTypeBundleInfo
->getBundleInfo('media');
$output = [];
foreach ($bundles as $id => $bundle) {
$output[$id]['label'] = $bundle['label'];
foreach ($this->entityFieldManager
->getFieldDefinitions('media', $id) as $fieldDefinition) {
if ($fieldDefinition
->getType() == 'file') {
$output[$id]['fields'][$fieldDefinition
->getName()] = $fieldDefinition
->getName();
}
}
}
return $output;
}
/**
* {@inheritdoc}
*/
public function submitForm(array &$form, FormStateInterface $form_state) {
$editableConfig = $this->configFactory
->getEditable(static::SETTINGS);
foreach ($this
->getFieldsList() as $bundleId => $infos) {
$editableConfig
->set($bundleId . '_field', $form_state
->getValue($bundleId . '_field'));
$editableConfig
->set($bundleId . '_enable', $form_state
->getValue($bundleId . '_enable'));
}
$editableConfig
->set('cron_enable', $form_state
->getValue('cron_enable'));
$editableConfig
->set('cron_time', $form_state
->getValue('cron_time'));
$editableConfig
->save();
parent::submitForm($form, $form_state);
}
/**
* {@inheritdoc}
*/
protected function getEditableConfigNames() {
return [
static::SETTINGS,
];
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
BundlesSettingsForm:: |
protected | property | ||
BundlesSettingsForm:: |
protected | property | ||
BundlesSettingsForm:: |
public | function |
Form constructor. Overrides ConfigFormBase:: |
|
BundlesSettingsForm:: |
public static | function |
Instantiates a new instance of this class. Overrides ConfigFormBase:: |
|
BundlesSettingsForm:: |
protected | function |
Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait:: |
|
BundlesSettingsForm:: |
protected | function | ||
BundlesSettingsForm:: |
public | function |
Returns a unique string identifying the form. Overrides FormInterface:: |
|
BundlesSettingsForm:: |
constant | Config settings. | ||
BundlesSettingsForm:: |
public | function |
Form submission handler. Overrides ConfigFormBase:: |
|
BundlesSettingsForm:: |
public | function |
BundlesSettingsForm constructor. Overrides ConfigFormBase:: |
|
ConfigFormBaseTrait:: |
protected | function | Retrieves a configuration object. | |
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 config factory. | 1 |
FormBase:: |
protected | property | The request stack. | 1 |
FormBase:: |
protected | property | The route match. | |
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. | |
FormBase:: |
public | function |
Form validation handler. Overrides FormInterface:: |
62 |
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:: |
protected | property | The messenger. | 29 |
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. | |
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. |