You are here

Home » API reference » Language Cookie 8 » NegotiationLanguageCookieForm.php

class NegotiationLanguageCookieForm in Language Cookie 8

Configure the Language cookie negotiation method for this site.

Hierarchy

Expanded class hierarchy of NegotiationLanguageCookieForm

1 string reference to 'NegotiationLanguageCookieForm'
language_cookie.routing.yml in ./language_cookie.routing.yml
language_cookie.routing.yml

File

src/Form/NegotiationLanguageCookieForm.php, line 13

Namespace

Drupal\language_cookie\Form
View source 
class NegotiationLanguageCookieForm extends ConfigFormBase {

  /**
   * The configuration.
   *
   * @var \Drupal\Core\Config\Config
   */
  protected $config;

  /**
   * The Language Cookie condition plugin manager.
   *
   * @var \Drupal\Core\Executable\ExecutableManagerInterface
   */
  protected $languageCookieConditionManager;

  /**
   * NegotiationLanguageCookieForm constructor.
   *
   * @param \Drupal\Core\Executable\ExecutableManagerInterface $plugin_manager
   *   The plugin manager.
   */
  public function __construct(ExecutableManagerInterface $plugin_manager) {
    parent::__construct($this
      ->configFactory());
    $this->languageCookieConditionManager = $plugin_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('plugin.manager.language_cookie_condition'));
  }

  /**
   * {@inheritdoc}
   */
  public function getFormId() {
    return 'language_cookie_admin_form';
  }

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'language_cookie.negotiation',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $this->config = $this
      ->config('language_cookie.negotiation');
    $form['param'] = [
      '#title' => $this
        ->t('Cookie parameter'),
      '#type' => 'textfield',
      '#default_value' => $this->config
        ->get('param'),
      '#description' => $this
        ->t('Name of the cookie parameter used to determine the desired language.'),
    ];
    $form['time'] = [
      '#title' => $this
        ->t('Cookie duration'),
      '#type' => 'textfield',
      '#default_value' => $this->config
        ->get('time'),
      '#description' => $this
        ->t('The time the cookie expires. This is the number of seconds from the current time.'),
    ];
    $form['path'] = [
      '#title' => $this
        ->t('Cookie path'),
      '#type' => 'textfield',
      '#default_value' => $this->config
        ->get('path'),
      '#description' => $this
        ->t('The cookie available server path'),
    ];
    $form['domain'] = [
      '#title' => $this
        ->t('Cookie domain scope'),
      '#type' => 'textfield',
      '#default_value' => $this->config
        ->get('domain'),
      '#description' => $this
        ->t('The cookie domain scope'),
    ];
    $form['secure'] = [
      '#title' => $this
        ->t('Secure cookie'),
      '#type' => 'checkbox',
      '#default_value' => $this->config
        ->get('secure'),
      '#description' => $this
        ->t('Whether the cookie should only be transmitted over a secure HTTPS connection from the client.'),
    ];
    $form['http_only'] = [
      '#title' => $this
        ->t('HttpOnly cookie'),
      '#type' => 'checkbox',
      '#default_value' => $this->config
        ->get('http_only'),
      '#description' => $this
        ->t('Prevent client-side scripts from accessing the cookie.'),
    ];
    $form['set_on_every_pageload'] = [
      '#title' => $this
        ->t('Re-send cookie on every page load'),
      '#type' => 'checkbox',
      '#description' => $this
        ->t('This will re-send a cookie on every page load, even if a cookie has already been set. This may be useful if you use a page cache such as Varnish and you plan to cache the language cookie. This prevents a user who already has a cookie visiting an uncached page and the cached version not setting a cookie.'),
      '#default_value' => $this->config
        ->get('set_on_every_pageload'),
    ];
    $manager = $this->languageCookieConditionManager;
    foreach ($manager
      ->getDefinitions() as $def) {
      $condition_plugin = $manager
        ->createInstance($def['id']);
      $form_state
        ->set([
        'conditions',
        $condition_plugin
          ->getPluginId(),
      ], $condition_plugin);
      $condition_plugin
        ->setConfiguration($condition_plugin
        ->getConfiguration() + (array) $this->config
        ->get());
      $condition_form = [];
      $condition_form['#markup'] = $condition_plugin
        ->getDescription();
      $condition_form += $condition_plugin
        ->buildConfigurationForm([], $form_state);
      if (!empty($condition_form[$condition_plugin
        ->getPluginId()])) {
        $condition_form['#type'] = 'details';
        $condition_form['#open'] = TRUE;
        $condition_form['#title'] = $condition_plugin
          ->getName();
        $condition_form['#weight'] = $condition_plugin
          ->getWeight();
        $form['conditions'][$condition_plugin
          ->getPluginId()] = $condition_form;
      }
    }
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    parent::validateForm($form, $form_state);

    /** @var \Drupal\language_cookie\LanguageCookieConditionInterface $condition */
    foreach ($form_state
      ->get([
      'conditions',
    ]) as $condition) {
      $condition
        ->validateConfigurationForm($form, $form_state);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    parent::submitForm($form, $form_state);
    $this->config
      ->set('param', $form_state
      ->getValue('param'))
      ->set('time', $form_state
      ->getValue('time'))
      ->set('path', $form_state
      ->getValue('path'))
      ->set('domain', $form_state
      ->getValue('domain'))
      ->set('secure', $form_state
      ->getValue('secure'))
      ->set('http_only', $form_state
      ->getValue('http_only'))
      ->set('set_on_every_pageload', $form_state
      ->getValue('set_on_every_pageload'));

    /** @var \Drupal\language_cookie\LanguageCookieConditionInterface $condition */
    foreach ($form_state
      ->get([
      'conditions',
    ]) as $condition) {
      $condition
        ->postConfigSave($this->config, $form, $form_state);
    }
    $this->config
      ->save();

    // Redirect to the language negotiation page on submit (previous Drupal 7
    // behavior, and intended behavior for other language negotiation settings
    // forms in Drupal 8 core).
    $form_state
      ->setRedirect('language.negotiation');
  }

}

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.
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.
NegotiationLanguageCookieForm::$config protected property The configuration.
NegotiationLanguageCookieForm::$languageCookieConditionManager protected property The Language Cookie condition plugin manager.
NegotiationLanguageCookieForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
NegotiationLanguageCookieForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
NegotiationLanguageCookieForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
NegotiationLanguageCookieForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
NegotiationLanguageCookieForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
NegotiationLanguageCookieForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
NegotiationLanguageCookieForm::__construct public function NegotiationLanguageCookieForm constructor. Overrides ConfigFormBase::__construct
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.