class LanguageNegotiationSession in Drupal 10

Identify language from a request/session parameter.

Plugin annotation

@LanguageNegotiation(
  id = Drupal\language\Plugin\LanguageNegotiation\LanguageNegotiationSession::METHOD_ID,
  weight = -6,
  name = @Translation("Session"),
  description = @Translation("Language from a request/session parameter."),
  config_route_name = "language.negotiation_session"
)

Hierarchy

• class \Drupal\language\LanguageNegotiationMethodBase implements LanguageNegotiationMethodInterface
  • class \Drupal\language\Plugin\LanguageNegotiation\LanguageNegotiationSession implements OutboundPathProcessorInterface, LanguageSwitcherInterface

2 files declare their use of LanguageNegotiationSession

LanguageNegotiationSessionTest.php in core/modules/language/tests/src/Functional/LanguageNegotiationSessionTest.php

LanguageUILanguageNegotiationTest.php in core/modules/language/tests/src/Functional/LanguageUILanguageNegotiationTest.php

File

core/modules/language/src/Plugin/LanguageNegotiation/LanguageNegotiationSession.php, line 24

Namespace

Drupal\language\Plugin\LanguageNegotiation

class LanguageNegotiationSession extends LanguageNegotiationMethodBase implements OutboundPathProcessorInterface, LanguageSwitcherInterface {

  /**
   * Flag used to determine whether query rewriting is active.
   *
   * @var bool
   */
  protected $queryRewrite;

  /**
   * The query parameter name to rewrite.
   *
   * @var string
   */
  protected $queryParam;

  /**
   * The query parameter value to be set.
   *
   * @var string
   */
  protected $queryValue;

  /**
   * The language negotiation method id.
   */
  const METHOD_ID = 'language-session';

  /**
   * {@inheritdoc}
   */
  public function getLangcode(Request $request = NULL) {
    $config = $this->config
      ->get('language.negotiation')
      ->get('session');
    $param = $config['parameter'];
    $langcode = $request && $request->query
      ->get($param) ? $request->query
      ->get($param) : NULL;
    if (!$langcode && isset($_SESSION[$param])) {
      $langcode = $_SESSION[$param];
    }
    return $langcode;
  }

  /**
   * {@inheritdoc}
   */
  public function persist(LanguageInterface $language) {

    // We need to update the session parameter with the request value only if we
    // have an authenticated user.
    $langcode = $language
      ->getId();
    if ($langcode && $this->languageManager) {
      $languages = $this->languageManager
        ->getLanguages();
      if ($this->currentUser
        ->isAuthenticated() && isset($languages[$langcode])) {
        $config = $this->config
          ->get('language.negotiation')
          ->get('session');
        $_SESSION[$config['parameter']] = $langcode;
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function processOutbound($path, &$options = [], Request $request = NULL, BubbleableMetadata $bubbleable_metadata = NULL) {
    if ($request) {

      // The following values are not supposed to change during a single page
      // request processing.
      if (!isset($this->queryRewrite)) {
        if ($this->currentUser
          ->isAnonymous()) {
          $languages = $this->languageManager
            ->getLanguages();
          $config = $this->config
            ->get('language.negotiation')
            ->get('session');
          $this->queryParam = $config['parameter'];
          $this->queryValue = $request->query
            ->has($this->queryParam) ? $request->query
            ->get($this->queryParam) : NULL;
          $this->queryRewrite = isset($languages[$this->queryValue]);
        }
        else {
          $this->queryRewrite = FALSE;
        }
      }

      // If the user is anonymous, the user language negotiation method is
      // enabled, and the corresponding option has been set, we must preserve
      // any explicit user language preference even with cookies disabled.
      if ($this->queryRewrite) {
        if (!isset($options['query'][$this->queryParam])) {
          $options['query'][$this->queryParam] = $this->queryValue;
        }
        if ($bubbleable_metadata) {

          // Cached URLs that have been processed by this outbound path
          // processor must be:
          $bubbleable_metadata
            ->addCacheTags($this->config
            ->get('language.negotiation')
            ->getCacheTags())
            ->addCacheContexts([
            'url.query_args:' . $this->queryParam,
          ]);
        }
      }
    }
    return $path;
  }

  /**
   * {@inheritdoc}
   */
  public function getLanguageSwitchLinks(Request $request, $type, Url $url) {
    $links = [];
    $config = $this->config
      ->get('language.negotiation')
      ->get('session');
    $param = $config['parameter'];
    $language_query = $_SESSION[$param] ?? $this->languageManager
      ->getCurrentLanguage($type)
      ->getId();
    $query = $request->query
      ->all();
    foreach ($this->languageManager
      ->getNativeLanguages() as $language) {
      $langcode = $language
        ->getId();
      $links[$langcode] = [
        // We need to clone the $url object to avoid using the same one for all
        // links. When the links are rendered, options are set on the $url
        // object, so if we use the same one, they would be set for all links.
        'url' => clone $url,
        'title' => $language
          ->getName(),
        'attributes' => [
          'class' => [
            'language-link',
          ],
        ],
        'query' => $query,
      ];
      if ($language_query != $langcode) {
        $links[$langcode]['query'][$param] = $langcode;
      }
      else {
        $links[$langcode]['attributes']['class'][] = 'session-active';
      }
    }
    return $links;
  }

}