public function Generic::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()

File

src/ContextProvider/Generic.php, line 32

Class

Generic

Exposes contexts from various provider services, under a single namespace.

Namespace

Drupal\core_context\ContextProvider

Code

public function getRuntimeContexts(array $unqualified_context_ids) {
  $contexts = [];
  foreach ($this->providers as $provider) {
    $contexts = array_merge($contexts, $provider
      ->getRuntimeContexts($unqualified_context_ids));
  }
  return $contexts;
}