You are here

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

class DomainLangNegotiationBrowserForm in Domain Lang 8

Configure the browser language negotiation method for this site.

Hierarchy

Expanded class hierarchy of DomainLangNegotiationBrowserForm

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

File

src/Form/DomainLangNegotiationBrowserForm.php, line 16

Namespace

Drupal\domain_lang\Form
View source 
class DomainLangNegotiationBrowserForm extends NegotiationBrowserForm {

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

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

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

  /**
   * {@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.mappings',
      $this->languageMappingsConfig,
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $form = [];

    // Initialize a language list to the ones available, including English.
    $languages = $this->languageManager
      ->getLanguages();
    $existing_languages = [];
    foreach ($languages as $langcode => $language) {
      $existing_languages[$langcode] = $language
        ->getName();
    }

    // If we have no languages available, present the list of predefined
    // languages only. If we do have already added languages, set up two option
    // groups with the list of existing and then predefined languages.
    if (empty($existing_languages)) {
      $language_options = $this->languageManager
        ->getStandardLanguageListWithoutConfigured();
    }
    else {
      $language_options = [
        (string) $this
          ->t('Existing languages') => $existing_languages,
        (string) $this
          ->t('Languages not yet added') => $this->languageManager
          ->getStandardLanguageListWithoutConfigured(),
      ];
    }
    $form['mappings'] = [
      '#type' => 'table',
      '#header' => [
        $this
          ->t('Browser language code'),
        $this
          ->t('Site language'),
        $this
          ->t('Operations'),
      ],
      '#attributes' => [
        'id' => 'language-negotiation-browser',
      ],
      '#empty' => $this
        ->t('No browser language mappings available.'),
    ];
    $mappings = $this
      ->language_get_browser_drupal_langcode_mappings();
    foreach ($mappings as $browser_langcode => $drupal_langcode) {
      $form['mappings'][$browser_langcode] = [
        'browser_langcode' => [
          '#title' => $this
            ->t('Browser language code'),
          '#title_display' => 'invisible',
          '#type' => 'textfield',
          '#default_value' => $browser_langcode,
          '#size' => 20,
          '#required' => TRUE,
        ],
        'drupal_langcode' => [
          '#title' => $this
            ->t('Site language'),
          '#title_display' => 'invisible',
          '#type' => 'select',
          '#options' => $language_options,
          '#default_value' => $drupal_langcode,
          '#required' => TRUE,
        ],
      ];

      // Operations column.
      $form['mappings'][$browser_langcode]['operations'] = [
        '#type' => 'operations',
        '#links' => [],
      ];
      $form['mappings'][$browser_langcode]['operations']['#links']['delete'] = [
        'title' => $this
          ->t('Delete'),
        'url' => Url::fromRoute('domain_lang.negotiation_browser_delete', [
          'domain' => $this->domainLangHandler
            ->getDomainFromUrl()
            ->id(),
          'browser_langcode' => $browser_langcode,
        ]),
      ];
    }

    // Add empty row.
    $form['new_mapping'] = [
      '#type' => 'details',
      '#title' => $this
        ->t('Add a new mapping'),
      '#tree' => TRUE,
    ];
    $form['new_mapping']['browser_langcode'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Browser language code'),
      '#description' => $this
        ->t('Use language codes as <a href=":w3ctags">defined by the W3C</a> for interoperability. <em>Examples: "en", "en-gb" and "zh-hant".</em>', [
        ':w3ctags' => 'http://www.w3.org/International/articles/language-tags/',
      ]),
      '#size' => 20,
    ];
    $form['new_mapping']['drupal_langcode'] = [
      '#type' => 'select',
      '#title' => $this
        ->t('Site language'),
      '#options' => $language_options,
    ];
    $form['actions']['#type'] = 'actions';
    $form['actions']['submit'] = [
      '#type' => 'submit',
      '#value' => $this
        ->t('Save configuration'),
      '#button_type' => 'primary',
    ];

    // By default, render the form using system-config-form.html.twig.
    $form['#theme'] = 'system_config_form';
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function submitForm(array &$form, FormStateInterface $form_state) {
    $mappings = $form_state
      ->get('mappings');
    if (!empty($mappings)) {
      $config = $this
        ->config($this->languageMappingsConfig);
      $config
        ->setData([
        'map' => $mappings,
      ]);
      $config
        ->save();
    }
    $form_state
      ->disableRedirect();
    $this
      ->messenger()
      ->addStatus($this
      ->t('The configuration options have been saved.'));
  }

  /**
   * Retrieves the browser's langcode mapping configuration array.
   *
   * @return array
   *   The browser's langcode mapping configuration array.
   */
  protected function language_get_browser_drupal_langcode_mappings() {
    $config = $this
      ->config($this->languageMappingsConfig);
    if ($config
      ->isNew()) {
      $config
        ->set('map', $this
        ->config('language.mappings')
        ->get('map'));
    }
    return $config
      ->get('map') ? $config
      ->get('map') : [];
  }

}

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
DomainLangNegotiationBrowserForm::$domainLangHandler protected property The domain lang handler.
DomainLangNegotiationBrowserForm::$languageMappingsConfig protected property Language mappings config name for current active domain.
DomainLangNegotiationBrowserForm::buildForm public function Form constructor. Overrides NegotiationBrowserForm::buildForm
DomainLangNegotiationBrowserForm::create public static function Instantiates a new instance of this class. Overrides NegotiationBrowserForm::create
DomainLangNegotiationBrowserForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides NegotiationBrowserForm::getEditableConfigNames
DomainLangNegotiationBrowserForm::language_get_browser_drupal_langcode_mappings protected function Retrieves the browser's langcode mapping configuration array. Overrides NegotiationBrowserForm::language_get_browser_drupal_langcode_mappings
DomainLangNegotiationBrowserForm::submitForm public function Form submission handler. Overrides NegotiationBrowserForm::submitForm
DomainLangNegotiationBrowserForm::__construct public function Constructs a \Drupal\system\ConfigFormBase object. Overrides NegotiationBrowserForm::__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.
NegotiationBrowserForm::$languageManager protected property The configurable language manager.
NegotiationBrowserForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
NegotiationBrowserForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
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.