You are here

Home » API reference » Cookie Content Blocker 8 » MediaSettingsForm.php

class MediaSettingsForm in Cookie Content Blocker 8

Form builder to manage settings for Cookie content blocker - Media.

@package Drupal\cookie_content_blocker_media\Form

Hierarchy

Expanded class hierarchy of MediaSettingsForm

1 string reference to 'MediaSettingsForm'
cookie_content_blocker_media.routing.yml in modules/cookie_content_blocker_media/cookie_content_blocker_media.routing.yml
modules/cookie_content_blocker_media/cookie_content_blocker_media.routing.yml

File

modules/cookie_content_blocker_media/src/Form/MediaSettingsForm.php, line 21

Namespace

Drupal\cookie_content_blocker_media\Form
View source 
class MediaSettingsForm extends ConfigFormBase {

  /**
   * The media source plugin manager.
   *
   * @var \Drupal\Component\Plugin\PluginManagerInterface
   */
  protected $mediaSourcePluginManager;

  /**
   * MediaSettingsForm constructor.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $configFactory
   *   The config factory.
   * @param \Drupal\Component\Plugin\PluginManagerInterface $mediaSourcePluginManager
   *   The media source plugin manager.
   */
  public function __construct(ConfigFactoryInterface $configFactory, PluginManagerInterface $mediaSourcePluginManager) {
    parent::__construct($configFactory);
    $this->mediaSourcePluginManager = $mediaSourcePluginManager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) : MediaSettingsForm {
    return new static($container
      ->get('config.factory'), $container
      ->get('plugin.manager.media.source'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() : string {
    return 'cookie_content_blocker_media_settings_form';
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() : array {
    return [
      'cookie_content_blocker_media.settings',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) : array {
    $form = parent::buildForm($form, $form_state);
    $sources = array_filter($this->mediaSourcePluginManager
      ->getDefinitions(), function ($definition) {
      return !empty($definition['providers']);
    });
    $form['providers'] = [
      '#type' => 'container',
      '#tree' => TRUE,
      '#title' => $this
        ->t('Providers'),
    ];
    $providers = array_unique(array_merge(...array_column($sources, 'providers')));
    foreach ($providers as $provider) {
      $form['providers'][$provider] = $this
        ->providerFormContainer($provider);
    }
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) : void {
    parent::submitForm($form, $form_state);
    $config = $this
      ->config('cookie_content_blocker_media.settings');
    $config
      ->set('providers', $form_state
      ->getValue('providers'));
    $config
      ->save();
  }

  /**
   * Create a container to configure provider settings.
   *
   * @param string $provider
   *   The name of the provider.
   *
   * @return array
   *   The event form container.
   */
  private function providerFormContainer(string $provider) : array {
    $config = $this
      ->config('cookie_content_blocker_media.settings')
      ->get("providers.{$provider}");
    $container = [
      '#type' => 'details',
      '#title' => $this
        ->t('Settings for %provider media', [
        '%provider' => $provider,
      ]),
      '#tree' => TRUE,
    ];
    $container['blocked'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Block %provider media', [
        '%provider' => $provider,
      ]),
      '#description' => $this
        ->t('Enable blocking of all %provider media until consent is given.', [
        '%provider' => $provider,
      ]),
      '#default_value' => $config['blocked'] ?? FALSE,
    ];
    $container['show_preview'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show a preview for blocked content'),
      '#default_value' => $config['show_preview'] ?? FALSE,
    ];
    $container['preview_style'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Choose an image style to use for the preview.'),
      '#options' => image_style_options(FALSE),
      '#default_value' => $config['preview_style'] ?? 'blocked_media_teaser',
      '#states' => [
        'visible' => [
          ':input[name="providers[' . $provider . '][show_preview]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $container['blocked_message'] = [
      '#type' => 'text_format',
      '#title' => $this
        ->t('Message for blocked %provider media', [
        '%provider' => $provider,
      ]),
      '#description' => $this
        ->t('When %provider media is blocked and a message is shown, this message will be shown.', [
        '%provider' => $provider,
      ]),
      '#default_value' => $config['blocked_message']['value'] ?? $this
        ->t('You have not yet given permission to place the required cookies. Accept the required cookies to view this content.'),
      '#format' => $config['blocked_message']['format'] ?? NULL,
      '#states' => [
        'visible' => [
          ':input[name="providers[' . $provider . '][blocked]"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    return $container;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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.
MediaSettingsForm::$mediaSourcePluginManager protected property The media source plugin manager.
MediaSettingsForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
MediaSettingsForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
MediaSettingsForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
MediaSettingsForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
MediaSettingsForm::providerFormContainer private function Create a container to configure provider settings.
MediaSettingsForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
MediaSettingsForm::__construct public function MediaSettingsForm constructor. Overrides ConfigFormBase::__construct
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.