class BlockerSettingsForm in Cookie Content Blocker 8

Form builder to manage settings related to the Cookie content blocker.

@package Drupal\cookie_content_blocker\Form

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\cookie_content_blocker\Form\BlockerSettingsForm

Expanded class hierarchy of BlockerSettingsForm

1 string reference to 'BlockerSettingsForm'

cookie_content_blocker.routing.yml in ./cookie_content_blocker.routing.yml: cookie_content_blocker.routing.yml

File

src/Form/BlockerSettingsForm.php, line 15

Namespace

Drupal\cookie_content_blocker\Form

View source

class BlockerSettingsForm extends ConfigFormBase {

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) : array {
    $form = parent::buildForm($form, $form_state);
    $config = $this
      ->config('cookie_content_blocker.settings');
    $form['blocked_message'] = [
      '#type' => 'textarea',
      '#title' => $this
        ->t('Default message for blocked content'),
      '#description' => $this
        ->t('When content is blocked and a message is shown, this message will be shown by default. Leave empty to use the default. Some basic HTML can be used.'),
      '#default_value' => $config
        ->get('blocked_message') ?? $this
        ->t('You have not yet given permission to place the required cookies. Accept the required cookies to view this content.'),
    ];
    $form['show_button'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Show a button to change cookie consent below the message for blocked content'),
      '#description' => $this
        ->t('When the button is shown the click event to change cookie consent will be turned on.'),
      '#default_value' => $config
        ->get('show_button') ?? TRUE,
    ];
    $form['button_text'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('The change cookie consent button text'),
      '#default_value' => $config
        ->get('button_text') ?? $this
        ->t('Show content'),
      '#states' => [
        'visible' => [
          ':input[name="show_button"]' => [
            'checked' => TRUE,
          ],
        ],
      ],
    ];
    $form['enable_click_consent_change'] = [
      '#type' => 'checkbox',
      '#title' => $this
        ->t('Enable changing consent by clicking on the blocked content'),
      '#description' => $this
        ->t('To show the blocked content, consent to the placement of cookies has to be given. By enabling this setting clicking on the blocked content wrapper will let the user change consent.'),
      '#default_value' => $config
        ->get('enable_click_consent_change') ?? TRUE,
      '#states' => [
        'visible' => [
          ':input[name="show_button"]' => [
            'checked' => FALSE,
          ],
        ],
      ],
    ];
    $form['consent_awareness'] = [
      '#type' => 'details',
      '#tree' => TRUE,
      '#title' => $this
        ->t('Consent awareness'),
      '#description' => $this
        ->t('Manage how Cookie content blocker knows about cookie consent and how it can change the consent. Note: only one cookie category is supported.'),
      '#collapsible' => TRUE,
      '#open' => TRUE,
      'accepted' => [
        '#type' => 'details',
        '#title' => $this
          ->t('Consent given'),
        '#description' => $this
          ->t('Define the event that is triggered when a visitor actively gives consent and the cookies to determine if consent already has been given earlier.'),
        '#collapsible' => TRUE,
        '#open' => FALSE,
      ],
      'declined' => [
        '#type' => 'details',
        '#title' => $this
          ->t('Consent refused'),
        '#description' => $this
          ->t('Define the event that is triggered when a visitor actively declines consent and the cookies to determine if consent already has been declined earlier.'),
        '#collapsible' => TRUE,
        '#open' => FALSE,
      ],
      'change' => [
        '#type' => 'details',
        '#title' => $this
          ->t('Consent changed'),
        '#description' => $this
          ->t('Define the event that has to be triggered when the button or blocked content placeholder is clicked.'),
        '#collapsible' => TRUE,
        '#open' => FALSE,
      ],
    ];
    foreach (Element::children($form['consent_awareness']) as $event_type) {
      $form['consent_awareness'][$event_type]['event'] = $this
        ->eventFormContainer($event_type);
      if ($event_type === 'change') {
        continue;
      }
      $form['consent_awareness'][$event_type]['cookie'] = $this
        ->cookieFormContainer($event_type);
    }
    return $form;
  }

  /**
   * Makes sure whitespaces are stripped off element values.
   *
   * @param array $element
   *   The element being validated.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function stripWhitespaces(array $element, FormStateInterface $form_state) : void {
    $form_state
      ->setValueForElement($element, trim($element['#value']));
  }

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

  /**
   * Returns a list of allowed cookie value operator options.
   *
   * @return array
   *   The cookie value operators.
   */
  private function cookieValueOperators() : array {
    return [
      '===' => $this
        ->t('Equals'),
      '>' => $this
        ->t('Greater than'),
      '<' => $this
        ->t('Less than'),
      'c' => $this
        ->t('Contains'),
      '!c' => $this
        ->t('Not contains'),
      'e' => $this
        ->t('Exists'),
      '!e' => $this
        ->t('Not exists'),
    ];
  }

  /**
   * Create a container to configure cookie settings.
   *
   * @param string $type
   *   The type of the event.
   *
   * @return array
   *   The event form container.
   */
  private function cookieFormContainer(string $type) : array {
    $defaults = $this
      ->config('cookie_content_blocker.settings')
      ->get('consent_awareness.' . $type . '.cookie') ?? [];
    $container = [];
    $container['operator'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Cookie comparison operator'),
      '#description' => $this
        ->t('The operator to use to compare the actual cookie value to the configured value'),
      '#default_value' => $defaults['operator'] ?? '',
      '#empty_option' => $this
        ->t('- Select -'),
      '#options' => $this
        ->cookieValueOperators(),
      '#element_validate' => [
        [
          $this,
          'stripWhitespaces',
        ],
      ],
    ];
    $container['name'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Cookie name'),
      '#description' => $this
        ->t('The name of the cookie to check for consent.'),
      '#default_value' => $defaults['name'] ?? '',
      '#element_validate' => [
        [
          $this,
          'stripWhitespaces',
        ],
      ],
    ];
    $container['value'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Cookie value'),
      '#description' => $this
        ->t('The value to use for comparison.'),
      '#default_value' => $defaults['value'] ?? '',
      '#element_validate' => [
        [
          $this,
          'stripWhitespaces',
        ],
      ],
    ];
    return $container;
  }

  /**
   * Create a container to configure event settings.
   *
   * @param string $type
   *   The type of the event.
   *
   * @return array
   *   The event form container.
   */
  private function eventFormContainer(string $type) : array {
    $defaults = $this
      ->config('cookie_content_blocker.settings')
      ->get('consent_awareness.' . $type . '.event') ?? [];
    $container = [];
    $container['name'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('JavaScript event name'),
      '#description' => $this
        ->t('The event for the element selected below.'),
      '#default_value' => $defaults['name'] ?? '',
      '#element_validate' => [
        [
          $this,
          'stripWhitespaces',
        ],
      ],
    ];
    $container['selector'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('JavaScript event DOM element selector'),
      '#description' => $this
        ->t("The jQuery selector of the DOM element the above event is associated with, omit the jQuery('') or \$('') part. E.g. 'window' or '.some-class > .other-child-class' (without quotes)."),
      '#default_value' => $defaults['selector'] ?? '',
      '#element_validate' => [
        [
          $this,
          'stripWhitespaces',
        ],
      ],
    ];
    return $container;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
BlockerSettingsForm::buildForm	public	function	Form constructor. Overrides ConfigFormBase::buildForm
BlockerSettingsForm::cookieFormContainer	private	function	Create a container to configure cookie settings.
BlockerSettingsForm::cookieValueOperators	private	function	Returns a list of allowed cookie value operator options.
BlockerSettingsForm::eventFormContainer	private	function	Create a container to configure event settings.
BlockerSettingsForm::getEditableConfigNames	protected	function	Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
BlockerSettingsForm::getFormId	public	function	Returns a unique string identifying the form. Overrides FormInterface::getFormId
BlockerSettingsForm::stripWhitespaces	public	function	Makes sure whitespaces are stripped off element values.
BlockerSettingsForm::submitForm	public	function	Form submission handler. Overrides ConfigFormBase::submitForm
ConfigFormBase::create	public static	function	Instantiates a new instance of this class. Overrides FormBase::create	13
ConfigFormBase::__construct	public	function	Constructs a \Drupal\system\ConfigFormBase object.	11
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 BlockerSettingsForm in Cookie Content Blocker 8

Hierarchy

File

Namespace

Members

API Navigation