class BundlesSettingsForm in Media PDF Thumbnail 8.3

Same name and namespace in other branches

8.4 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

Expanded class hierarchy of BundlesSettingsForm

1 file declares its use of BundlesSettingsForm

MediaPdfThumbnailFieldFormatter.php in src/Plugin/Field/FieldFormatter/MediaPdfThumbnailFieldFormatter.php

1 string reference to 'BundlesSettingsForm'

media_pdf_thumbnail.routing.yml in ./media_pdf_thumbnail.routing.yml: media_pdf_thumbnail.routing.yml

File

src/Form/BundlesSettingsForm.php, line 15

Namespace

Drupal\media_pdf_thumbnail\Form

View 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'),
        ];
      }
    }
    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
      ->save();
    parent::submitForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      static::SETTINGS,
    ];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BundlesSettingsForm::$entityFieldManager	protected	property
BundlesSettingsForm::$entityTypeBundleInfo	protected	property
BundlesSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
BundlesSettingsForm::create	public static	function	Instantiates a new instance of this class. Overrides ConfigFormBase::create
BundlesSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
BundlesSettingsForm::getFieldsList	protected	function
BundlesSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
BundlesSettingsForm::SETTINGS		constant	Config settings.
BundlesSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
BundlesSettingsForm::__construct	public	function	BundlesSettingsForm constructor. Overrides ConfigFormBase::__construct
ConfigFormBaseTrait::config	protected	function	Retrieves a configuration object.
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::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	protected	property	The messenger.	29
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.

You are here

class BundlesSettingsForm in Media PDF Thumbnail 8.3

Hierarchy

File

Namespace

Members

API Navigation