public function CurrentLanguageContext::getRuntimeContexts in Drupal 8

Same name and namespace in other branches

1. 9 core/lib/Drupal/Core/Language/ContextProvider/CurrentLanguageContext.php \Drupal\Core\Language\ContextProvider\CurrentLanguageContext::getRuntimeContexts()
2. 10 core/lib/Drupal/Core/Language/ContextProvider/CurrentLanguageContext.php \Drupal\Core\Language\ContextProvider\CurrentLanguageContext::getRuntimeContexts()

Gets runtime context values for the given context IDs.

For context-aware plugins to function correctly, all of the contexts that they require must be populated with values. So this method should set a value for each context that it adds. For example:

  // Determine a specific node to pass as context to a block.
  $node = ...

  // Set that specific node as the value of the 'node' context.
  $context = EntityContext::fromEntity($node);
  return ['node' => $context];

On the other hand, there are cases, on which providers no longer are possible to provide context objects, even without the value, so the caller should not expect it.

Parameters

string[] $unqualified_context_ids: The requested context IDs. The context provider must only return contexts for those IDs.

Return value

\Drupal\Core\Plugin\Context\ContextInterface[] The determined available contexts, keyed by the unqualified context_id.

Overrides ContextProviderInterface::getRuntimeContexts

See also

\Drupal\Core\Plugin\Context\ContextProviderInterface:getAvailableContexts()

1 call to CurrentLanguageContext::getRuntimeContexts()

CurrentLanguageContext::getAvailableContexts in core/lib/Drupal/Core/Language/ContextProvider/CurrentLanguageContext.php

Gets all available contexts for the purposes of configuration.

File

core/lib/Drupal/Core/Language/ContextProvider/CurrentLanguageContext.php, line 39

Class

CurrentLanguageContext

Sets the current language as a context.

Namespace

Drupal\Core\Language\ContextProvider

Code

public function getRuntimeContexts(array $unqualified_context_ids) {

  // Add a context for each language type.
  $language_types = $this->languageManager
    ->getLanguageTypes();
  $info = $this->languageManager
    ->getDefinedLanguageTypesInfo();
  if ($unqualified_context_ids) {
    foreach ($unqualified_context_ids as $unqualified_context_id) {
      if (array_search($unqualified_context_id, $language_types) === FALSE) {
        unset($language_types[$unqualified_context_id]);
      }
    }
  }
  $result = [];
  foreach ($language_types as $type_key) {
    if (isset($info[$type_key]['name'])) {
      $context = new Context(new ContextDefinition('language', $info[$type_key]['name']), $this->languageManager
        ->getCurrentLanguage($type_key));
      $cacheability = new CacheableMetadata();
      $cacheability
        ->setCacheContexts([
        'languages:' . $type_key,
      ]);
      $context
        ->addCacheableDependency($cacheability);
      $result[$type_key] = $context;
    }
  }
  return $result;
}