NegotiationUrlForm.php

Contains \Drupal\language\Form\NegotiationUrlForm.

Namespace

Drupal\language\Form

File

drupal/core/modules/language/lib/Drupal/language/Form/NegotiationUrlForm.php
View source
<?php

/**
 * @file
 * Contains \Drupal\language\Form\NegotiationUrlForm.
 */
namespace Drupal\language\Form;

use Drupal\system\SystemConfigFormBase;

/**
 * Configure the URL language negotiation method for this site.
 */
class NegotiationUrlForm extends SystemConfigFormBase {

  /**
   * Implements \Drupal\Core\Form\FormInterface::getFormID().
   */
  public function getFormID() {
    return 'language_negotiation_configure_url_form';
  }

  /**
   * Implements \Drupal\Core\Form\FormInterface::buildForm().
   */
  public function buildForm(array $form, array &$form_state) {
    global $base_url;
    $config = $this->configFactory
      ->get('language.negotiation');
    language_negotiation_include();
    $form['language_negotiation_url_part'] = array(
      '#title' => t('Part of the URL that determines language'),
      '#type' => 'radios',
      '#options' => array(
        LANGUAGE_NEGOTIATION_URL_PREFIX => t('Path prefix'),
        LANGUAGE_NEGOTIATION_URL_DOMAIN => t('Domain'),
      ),
      '#default_value' => $config
        ->get('url.source'),
    );
    $form['prefix'] = array(
      '#type' => 'details',
      '#tree' => TRUE,
      '#title' => t('Path prefix configuration'),
      '#description' => t('Language codes or other custom text to use as a path prefix for URL language detection. For the default 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' => array(
        'visible' => array(
          ':input[name="language_negotiation_url_part"]' => array(
            'value' => (string) LANGUAGE_NEGOTIATION_URL_PREFIX,
          ),
        ),
      ),
    );
    $form['domain'] = array(
      '#type' => 'details',
      '#tree' => TRUE,
      '#title' => t('Domain configuration'),
      '#description' => t('The domain names to use for these languages. Leave blank for the default language. Use with caution in a production environment.<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 an URL like "http://de.example.com/contact".'),
      '#states' => array(
        'visible' => array(
          ':input[name="language_negotiation_url_part"]' => array(
            'value' => (string) LANGUAGE_NEGOTIATION_URL_DOMAIN,
          ),
        ),
      ),
    );
    $languages = language_list();
    $prefixes = language_negotiation_url_prefixes();
    $domains = language_negotiation_url_domains();
    foreach ($languages as $langcode => $language) {
      $t_args = array(
        '%language' => $language->name,
        '%langcode' => $language->langcode,
      );
      $form['prefix'][$langcode] = array(
        '#type' => 'textfield',
        '#title' => $language->default ? t('%language (%langcode) path prefix (Default language)', $t_args) : t('%language (%langcode) path prefix', $t_args),
        '#maxlength' => 64,
        '#default_value' => isset($prefixes[$langcode]) ? $prefixes[$langcode] : '',
        '#field_prefix' => $base_url . '/',
      );
      $form['domain'][$langcode] = array(
        '#type' => 'textfield',
        '#title' => t('%language (%langcode) domain', array(
          '%language' => $language->name,
          '%langcode' => $language->langcode,
        )),
        '#maxlength' => 128,
        '#default_value' => isset($domains[$langcode]) ? $domains[$langcode] : '',
      );
    }
    $form_state['redirect'] = 'admin/config/regional/language/detection';
    return parent::buildForm($form, $form_state);
  }

  /**
   * Implements \Drupal\Core\Form\FormInterface::validateForm().
   */
  public function validateForm(array &$form, array &$form_state) {
    $languages = language_list();

    // Count repeated values for uniqueness check.
    $count = array_count_values($form_state['values']['prefix']);
    foreach ($languages as $langcode => $language) {
      $value = $form_state['values']['prefix'][$langcode];
      if ($value === '') {
        if (!$language->default && $form_state['values']['language_negotiation_url_part'] == LANGUAGE_NEGOTIATION_URL_PREFIX) {

          // Throw a form error if the prefix is blank for a non-default language,
          // although it is required for selected negotiation type.
          form_error($form['prefix'][$langcode], t('The prefix may only be left blank for the default language.'));
        }
      }
      elseif (strpos($value, '/') !== FALSE) {

        // Throw a form error if the string contains a slash,
        // which would not work.
        form_error($form['prefix'][$langcode], 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_error($form['prefix'][$langcode], t('The prefix for %language, %value, is not unique.', array(
          '%language' => $language->name,
          '%value' => $value,
        )));
      }
    }

    // Count repeated values for uniqueness check.
    $count = array_count_values($form_state['values']['domain']);
    foreach ($languages as $langcode => $language) {
      $value = $form_state['values']['domain'][$langcode];
      if ($value === '') {
        if (!$language->default && $form_state['values']['language_negotiation_url_part'] == LANGUAGE_NEGOTIATION_URL_DOMAIN) {

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

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

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

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

  /**
   * Implements \Drupal\Core\Form\FormInterface::submitForm().
   */
  public function submitForm(array &$form, array &$form_state) {

    // Save selected format (prefix or domain).
    $this->configFactory
      ->get('language.negotiation')
      ->set('url.source', $form_state['values']['language_negotiation_url_part'])
      ->save();

    // Save new domain and prefix values.
    language_negotiation_url_prefixes_save($form_state['values']['prefix']);
    language_negotiation_url_domains_save($form_state['values']['domain']);
    parent::submitForm($form, $form_state);
  }

}

Classes

Namesort descending Description
NegotiationUrlForm Configure the URL language negotiation method for this site.