You are here

Home » API reference » Language Selection Page 8.2 » NegotiationLanguageSelectionPageForm.php

final class NegotiationLanguageSelectionPageForm in Language Selection Page 8.2

Configure the Language Selection Page language negotiation method.

Hierarchy

Expanded class hierarchy of NegotiationLanguageSelectionPageForm

1 string reference to 'NegotiationLanguageSelectionPageForm'
language_selection_page.routing.yml in ./language_selection_page.routing.yml
language_selection_page.routing.yml

File

src/Form/NegotiationLanguageSelectionPageForm.php, line 16

Namespace

Drupal\language_selection_page\Form
View source 
final class NegotiationLanguageSelectionPageForm extends ConfigFormBase implements ContainerInjectionInterface {

  /**
   * The variable containing the conditions configuration.
   *
   * @var \Drupal\Core\Config\Config
   */
  protected $config;

  /**
   * The Language Selection Page condition plugin manager.
   *
   * @var \Drupal\Core\Executable\ExecutableManagerInterface
   */
  protected $languageSelectionPageConditionManager;

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

  /**
   * {@inheritdoc}
   */
  public function buildForm(array $form, FormStateInterface $form_state) {
    $this->config = $this
      ->config('language_selection_page.negotiation');
    $manager = $this->languageSelectionPageConditionManager;
    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 static function create(ContainerInterface $container) {
    return new static($container
      ->get('plugin.manager.language_selection_page_condition'));
  }

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

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

    /** @var \Drupal\language_selection_page\LanguageSelectionPageConditionInterface $condition */
    foreach ($form_state
      ->get([
      'conditions',
    ]) as $condition) {
      $condition
        ->submitConfigurationForm($form, $form_state);
      if (\array_key_exists($condition
        ->getPluginId(), $condition
        ->getConfiguration())) {
        $this->config
          ->set($condition
          ->getPluginId(), $condition
          ->getConfiguration()[$condition
          ->getPluginId()]);
      }
    }
    $this->config
      ->save();

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

    // 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');
  }

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

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

  /**
   * {@inheritdoc}
   */
  protected function getEditableConfigNames() {
    return [
      'language_selection_page.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.
NegotiationLanguageSelectionPageForm::$config protected property The variable containing the conditions configuration.
NegotiationLanguageSelectionPageForm::$languageSelectionPageConditionManager protected property The Language Selection Page condition plugin manager.
NegotiationLanguageSelectionPageForm::buildForm public function Form constructor. Overrides ConfigFormBase::buildForm
NegotiationLanguageSelectionPageForm::create public static function Instantiates a new instance of this class. Overrides ConfigFormBase::create
NegotiationLanguageSelectionPageForm::getEditableConfigNames protected function Gets the configuration names that will be editable. Overrides ConfigFormBaseTrait::getEditableConfigNames
NegotiationLanguageSelectionPageForm::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
NegotiationLanguageSelectionPageForm::submitForm public function Form submission handler. Overrides ConfigFormBase::submitForm
NegotiationLanguageSelectionPageForm::validateForm public function Form validation handler. Overrides FormBase::validateForm
NegotiationLanguageSelectionPageForm::__construct public function NegotiationLanguageSelectionPageForm 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.