public function RouteAwareContextProviderBase::getRuntimeContexts in Core Context 8

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 RouteAwareContextProviderBase::getRuntimeContexts()

RouteAwareContextProviderBase::getAvailableContexts in src/ContextProvider/RouteAwareContextProviderBase.php

Gets all available contexts for the purposes of configuration.

File

src/ContextProvider/RouteAwareContextProviderBase.php, line 64

Class

RouteAwareContextProviderBase

Provides a base class for context providers which use the current route.

Namespace

Drupal\core_context\ContextProvider

Code

public function getRuntimeContexts(array $unqualified_context_ids) {
  $route = $this->routeMatch
    ->getRouteObject();
  if (empty($route) || $this
    ->appliesTo($route) === FALSE) {
    return [];
  }
  $contexts = $this
    ->getContextsFromRoute($route);
  if ($unqualified_context_ids) {
    $contexts = array_intersect_key($contexts, array_flip($unqualified_context_ids));
  }
  $cache_metadata = new CacheableMetadata();
  $cache_metadata
    ->addCacheContexts([
    'route',
  ]);
  return $this
    ->applyCaching($contexts, $cache_metadata);
}