class GraphQLLanguageContext in GraphQL 8.3

Simple service that stores the current GraphQL language state.

Hierarchy

• class \Drupal\graphql\GraphQLLanguageContext

1 file declares its use of GraphQLLanguageContext

LanguageNegotiationGraphQL.php in src/Plugin/LanguageNegotiation/LanguageNegotiationGraphQL.php

1 string reference to 'GraphQLLanguageContext'

graphql.services.yml in ./graphql.services.yml

graphql.services.yml

1 service uses GraphQLLanguageContext

graphql.language_context in ./graphql.services.yml

Drupal\graphql\GraphQLLanguageContext

File

src/GraphQLLanguageContext.php, line 12

Namespace

Drupal\graphql

class GraphQLLanguageContext {

  /**
   * Indicates if the GraphQL context language is currently active.
   *
   * @var bool
   */
  protected $isActive;

  /**
   * The current language context.
   *
   * @var string
   */
  protected $currentLanguage;

  /**
   * @var \SplStack
   */
  protected $languageStack;

  /**
   * The language manager service.
   *
   * @var \Drupal\Core\Language\LanguageManagerInterface
   */
  protected $languageManager;

  /**
   * The string translation service
   *
   * @var \Drupal\Core\StringTranslation\TranslationManager
   */
  protected $translationManager;

  /**
   * GraphQLLanguageContext constructor.
   *
   * @param \Drupal\Core\Language\LanguageManagerInterface $languageManager
   *   The language manager service.
   */
  public function __construct(LanguageManagerInterface $languageManager, TranslationManager $translationManager) {
    $this->languageManager = $languageManager;
    $this->translationManager = $translationManager;
    $this->languageStack = new \SplStack();
  }

  /**
   * Retrieve the current language.
   *
   * @return string|null
   *   The current language code, or null if the context is not active.
   */
  public function getCurrentLanguage() {
    return $this->isActive ? $this->currentLanguage ?: $this->languageManager
      ->getDefaultLanguage()
      ->getId() : NULL;
  }

  /**
   * Executes a callable in a defined language context.
   *
   * @param callable $callable
   *   The callable to be executed.
   * @param string $language
   *   The langcode to be set.
   *
   * @return mixed
   *   The callables result.
   *
   * @throws \Exception
   *   Any exception caught while executing the callable.
   */
  public function executeInLanguageContext(callable $callable, $language) {
    $this->languageStack
      ->push($this->currentLanguage);
    $this->currentLanguage = $language;
    $this->isActive = TRUE;
    $this->languageManager
      ->reset();

    // This is needed to be able to use the string translation with the
    // requested language.
    $this->translationManager
      ->setDefaultLangcode($language);

    // Override the configuration language so that config entities (like menus)
    // are loaded using the proper translation.
    $currentConfigLanguage = $this->languageManager
      ->getConfigOverrideLanguage();
    if ($currentConfigLanguage
      ->getId() !== $language) {
      $configLanguage = $this->languageManager
        ->getLanguage($language);
      $this->languageManager
        ->setConfigOverrideLanguage($configLanguage);
    }

    // Extract the result array.
    try {
      return call_user_func($callable);
    } catch (\Exception $exc) {
      throw $exc;
    } finally {

      // In any case, set the language context back to null.
      $this->currentLanguage = $this->languageStack
        ->pop();
      $this->isActive = FALSE;
      $this->languageManager
        ->reset();

      // Restore the languages for the translation and language managers.
      $defaultLangcode = !empty($this->currentLanguage) ? $this->currentLanguage : $this->languageManager
        ->getDefaultLanguage()
        ->getId();
      $this->translationManager
        ->setDefaultLangcode($defaultLangcode);
      $this->languageManager
        ->setConfigOverrideLanguage($currentConfigLanguage);
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
GraphQLLanguageContext::$currentLanguage	protected	property	The current language context.
GraphQLLanguageContext::$isActive	protected	property	Indicates if the GraphQL context language is currently active.
GraphQLLanguageContext::$languageManager	protected	property	The language manager service.
GraphQLLanguageContext::$languageStack	protected	property
GraphQLLanguageContext::$translationManager	protected	property	The string translation service
GraphQLLanguageContext::executeInLanguageContext	public	function	Executes a callable in a defined language context.
GraphQLLanguageContext::getCurrentLanguage	public	function	Retrieve the current language.
GraphQLLanguageContext::__construct	public	function	GraphQLLanguageContext constructor.