You are here

Home » API reference » Drupal 8 » NegotiationUrlForm.php

class NegotiationUrlForm in Drupal 8

Same name and namespace in other branches
  1. 9 core/modules/language/src/Form/NegotiationUrlForm.php \Drupal\language\Form\NegotiationUrlForm
  2. 10 core/modules/language/src/Form/NegotiationUrlForm.php \Drupal\language\Form\NegotiationUrlForm

Configure the URL language negotiation method for this site.

@internal

Hierarchy

Expanded class hierarchy of NegotiationUrlForm

1 string reference to 'NegotiationUrlForm'
language.routing.yml in core/modules/language/language.routing.yml
core/modules/language/language.routing.yml

File

core/modules/language/src/Form/NegotiationUrlForm.php, line 19

Namespace

Drupal\language\Form
View source 
class NegotiationUrlForm extends ConfigFormBase {

  /**
   * The language manager.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

  /**
   * Constructs a new NegotiationUrlForm object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager.
   */
  public function __construct(ConfigFactoryInterface $config_factory, LanguageManagerInterface $language_manager) {
    parent::__construct($config_factory);
    $this->languageManager = $language_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container) {
    return new static($container
      ->get('config.factory'), $container
      ->get('language_manager'));
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    global $base_url;
    $config = $this
      ->config('language.negotiation');
    $form['language_negotiation_url_part'] = [
      '#title' => $this
        ->t('Part of the URL that determines language'),
      '#type' => 'radios',
      '#options' => [
        LanguageNegotiationUrl::CONFIG_PATH_PREFIX => $this
          ->t('Path prefix'),
        LanguageNegotiationUrl::CONFIG_DOMAIN => $this
          ->t('Domain'),
      ],
      '#default_value' => $config
        ->get('url.source'),
    ];
    $form['prefix'] = [
      '#type' => 'details',
      '#tree' => TRUE,
      '#title' => $this
        ->t('Path prefix configuration'),
      '#open' => TRUE,
      '#description' => $this
        ->t('Language codes or other custom text to use as a path prefix for URL language detection. For the selected fallback language, this value may be left blank. <strong>Modifying this value may break existing URLs. Use with caution in a production environment.</strong> Example: Specifying "deutsch" as the path prefix code for German results in URLs like "example.com/deutsch/contact".'),
      '#states' => [
        'visible' => [
          ':input[name="language_negotiation_url_part"]' => [
            'value' => (string) LanguageNegotiationUrl::CONFIG_PATH_PREFIX,
          ],
        ],
      ],
    ];
    $form['domain'] = [
      '#type' => 'details',
      '#tree' => TRUE,
      '#title' => $this
        ->t('Domain configuration'),
      '#open' => TRUE,
      '#description' => $this
        ->t('The domain names to use for these languages. <strong>Modifying this value may break existing URLs. Use with caution in a production environment.</strong> Example: Specifying "de.example.com" as language domain for German will result in a URL like "http://de.example.com/contact".'),
      '#states' => [
        'visible' => [
          ':input[name="language_negotiation_url_part"]' => [
            'value' => (string) LanguageNegotiationUrl::CONFIG_DOMAIN,
          ],
        ],
      ],
    ];
    $languages = $this->languageManager
      ->getLanguages();
    $prefixes = $config
      ->get('url.prefixes');
    $domains = $config
      ->get('url.domains');
    foreach ($languages as $langcode => $language) {
      $t_args = [
        '%language' => $language
          ->getName(),
        '%langcode' => $language
          ->getId(),
      ];
      $form['prefix'][$langcode] = [
        '#type' => 'textfield',
        '#title' => $language
          ->isDefault() ? $this
          ->t('%language (%langcode) path prefix (Default language)', $t_args) : $this
          ->t('%language (%langcode) path prefix', $t_args),
        '#maxlength' => 64,
        '#default_value' => isset($prefixes[$langcode]) ? $prefixes[$langcode] : '',
        '#field_prefix' => $base_url . '/',
      ];
      $form['domain'][$langcode] = [
        '#type' => 'textfield',
        '#title' => $this
          ->t('%language (%langcode) domain', [
          '%language' => $language
            ->getName(),
          '%langcode' => $language
            ->getId(),
        ]),
        '#maxlength' => 128,
        '#default_value' => isset($domains[$langcode]) ? $domains[$langcode] : '',
      ];
    }
    $form_state
      ->setRedirect('language.negotiation');
    return parent::buildForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function validateForm(array &$form, FormStateInterface $form_state) {
    $languages = $this->languageManager
      ->getLanguages();

    // Count repeated values for uniqueness check.
    $count = array_count_values($form_state
      ->getValue('prefix'));
    $default_langcode = $this
      ->config('language.negotiation')
      ->get('selected_langcode');
    if ($default_langcode == LanguageInterface::LANGCODE_SITE_DEFAULT) {
      $default_langcode = $this->languageManager
        ->getDefaultLanguage()
        ->getId();
    }
    foreach ($languages as $langcode => $language) {
      $value = $form_state
        ->getValue([
        'prefix',
        $langcode,
      ]);
      if ($value === '') {
        if (!($default_langcode == $langcode) && $form_state
          ->getValue('language_negotiation_url_part') == LanguageNegotiationUrl::CONFIG_PATH_PREFIX) {

          // Throw a form error if the prefix is blank for a non-default language,
          // although it is required for selected negotiation type.
          $form_state
            ->setErrorByName("prefix][{$langcode}", $this
            ->t('The prefix may only be left blank for the <a href=":url">selected detection fallback language.</a>', [
            ':url' => Url::fromRoute('language.negotiation_selected')
              ->toString(),
          ]));
        }
      }
      elseif (strpos($value, '/') !== FALSE) {

        // Throw a form error if the string contains a slash,
        // which would not work.
        $form_state
          ->setErrorByName("prefix][{$langcode}", $this
          ->t('The prefix may not contain a slash.'));
      }
      elseif (isset($count[$value]) && $count[$value] > 1) {

        // Throw a form error if there are two languages with the same
        // domain/prefix.
        $form_state
          ->setErrorByName("prefix][{$langcode}", $this
          ->t('The prefix for %language, %value, is not unique.', [
          '%language' => $language
            ->getName(),
          '%value' => $value,
        ]));
      }
    }

    // Count repeated values for uniqueness check.
    $count = array_count_values($form_state
      ->getValue('domain'));
    foreach ($languages as $langcode => $language) {
      $value = $form_state
        ->getValue([
        'domain',
        $langcode,
      ]);
      if ($value === '') {
        if ($form_state
          ->getValue('language_negotiation_url_part') == LanguageNegotiationUrl::CONFIG_DOMAIN) {

          // Throw a form error if the domain is blank for a non-default language,
          // although it is required for selected negotiation type.
          $form_state
            ->setErrorByName("domain][{$langcode}", $this
            ->t('The domain may not be left blank for %language.', [
            '%language' => $language
              ->getName(),
          ]));
        }
      }
      elseif (isset($count[$value]) && $count[$value] > 1) {

        // Throw a form error if there are two languages with the same
        // domain/domain.
        $form_state
          ->setErrorByName("domain][{$langcode}", $this
          ->t('The domain for %language, %value, is not unique.', [
          '%language' => $language
            ->getName(),
          '%value' => $value,
        ]));
      }
    }

    // Domain names should not contain protocol and/or ports.
    foreach ($languages as $langcode => $language) {
      $value = $form_state
        ->getValue([
        'domain',
        $langcode,
      ]);
      if (!empty($value)) {

        // Ensure we have exactly one protocol when checking the hostname.
        $host = 'http://' . str_replace([
          'http://',
          'https://',
        ], '', $value);
        if (parse_url($host, PHP_URL_HOST) != $value) {
          $form_state
            ->setErrorByName("domain][{$langcode}", $this
            ->t('The domain for %language may only contain the domain name, not a trailing slash, protocol and/or port.', [
            '%language' => $language
              ->getName(),
          ]));
        }
      }
    }
    parent::validateForm($form, $form_state);
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {

    // Save selected format (prefix or domain).
    $this
      ->config('language.negotiation')
      ->set('url.source', $form_state
      ->getValue('language_negotiation_url_part'))
      ->set('url.prefixes', $form_state
      ->getValue('prefix'))
      ->set('url.domains', $form_state
      ->getValue('domain'))
      ->save();
    parent::submitForm($form, $form_state);
  }

}

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