You are here

Home » API reference » Domain Lang 8 » DomainLangNegotiationUrlForm.php

class DomainLangNegotiationUrlForm in Domain Lang 8

Configure the URL language negotiation method for this site.

Hierarchy

Expanded class hierarchy of DomainLangNegotiationUrlForm

1 string reference to 'DomainLangNegotiationUrlForm'
domain_lang.routing.yml in ./domain_lang.routing.yml
domain_lang.routing.yml

File

src/Form/DomainLangNegotiationUrlForm.php, line 18

Namespace

Drupal\domain_lang\Form
View source 
class DomainLangNegotiationUrlForm extends NegotiationUrlForm {

  /**
   * The domain lang handler.
   *
   * @var \Drupal\domain_lang\DomainLangHandlerInterface
   */
  protected $domainLangHandler;

  /**
   * Language negotiation config name for current active domain.
   *
   * @var string
   */
  protected $languageNegotiationConfig;

  /**
   * Constructs a \Drupal\system\ConfigFormBase object.
   *
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The factory for configuration objects.
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The language manager.
   * @param \Drupal\domain_lang\DomainLangHandlerInterface $domain_lang_handler
   *   The domain lang handler.
   */
  public function __construct(ConfigFactoryInterface $config_factory, LanguageManagerInterface $language_manager, DomainLangHandlerInterface $domain_lang_handler) {
    parent::__construct($config_factory, $language_manager);
    $this->domainLangHandler = $domain_lang_handler;
    $this->languageNegotiationConfig = $this->domainLangHandler
      ->getDomainConfigName('language.negotiation');
  }

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

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $config = $this
      ->config($this->languageNegotiationConfig);
    $form = parent::buildForm($form, $form_state);

    // Fill with initial values on first page visit.
    if (!$config
      ->get('url.source')) {
      $config
        ->set('url.source', $this
        ->config('language.negotiation')
        ->get('url.source'));
    }
    if (!$config
      ->get('url.prefixes')) {
      $config
        ->set('url.prefixes', $this
        ->config('language.negotiation')
        ->get('url.prefixes'));
    }
    if (!$config
      ->get('url.domains')) {
      $config
        ->set('url.domains', $this
        ->config('language.negotiation')
        ->get('url.domains'));
    }
    if (isset($form['language_negotiation_url_part'])) {
      $form['language_negotiation_url_part']['#default_value'] = $config
        ->get('url.source');
    }
    $domain = $this->domainLangHandler
      ->getDomainFromUrl();
    $languages = $this->languageManager
      ->getLanguages();
    $prefixes = $config
      ->get('url.prefixes');
    $domains = $config
      ->get('url.domains');
    foreach ($languages as $langcode => $language) {
      if (isset($form['prefix'], $form['prefix'][$langcode])) {
        $form['prefix'][$langcode]['#default_value'] = isset($prefixes[$langcode]) ? $prefixes[$langcode] : '';
        $form['prefix'][$langcode]['#field_prefix'] = $domain
          ->getPath();
      }
      if (isset($form['domain'], $form['domain'][$langcode])) {
        $form['domain'][$langcode]['#default_value'] = isset($domains[$langcode]) ? $domains[$langcode] : '';
      }
    }
    return $form;
  }

  /**
   * {@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($this->languageNegotiationConfig)
      ->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($this->languageNegotiationConfig)
      ->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();
    $form_state
      ->disableRedirect();
    $this
      ->messenger()
      ->addStatus($this
      ->t('The configuration options have been saved.'));
  }

}

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
DomainLangNegotiationUrlForm::$domainLangHandler protected property The domain lang handler.
DomainLangNegotiationUrlForm::$languageNegotiationConfig protected property Language negotiation config name for current active domain.
DomainLangNegotiationUrlForm::buildForm public function Form constructor. Overrides NegotiationUrlForm::buildForm
DomainLangNegotiationUrlForm::create public static function Instantiates a new instance of this class. Overrides NegotiationUrlForm::create
DomainLangNegotiationUrlForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides NegotiationUrlForm::getEditableConfigNames
DomainLangNegotiationUrlForm::submitForm public function Form submission handler. Overrides NegotiationUrlForm::submitForm
DomainLangNegotiationUrlForm::validateForm public function Form validation handler. Overrides NegotiationUrlForm::validateForm
DomainLangNegotiationUrlForm::__construct public function Constructs a \Drupal\system\ConfigFormBase object. Overrides NegotiationUrlForm::__construct
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::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
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.