public function MultipleStaticContext::getRuntimeContexts in Drupal 8

Same name and namespace in other branches

1. 9 core/modules/block/tests/modules/block_test/src/ContextProvider/MultipleStaticContext.php \Drupal\block_test\ContextProvider\MultipleStaticContext::getRuntimeContexts()
2. 10 core/modules/block/tests/modules/block_test/src/ContextProvider/MultipleStaticContext.php \Drupal\block_test\ContextProvider\MultipleStaticContext::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 MultipleStaticContext::getRuntimeContexts()

MultipleStaticContext::getAvailableContexts in core/modules/block/tests/modules/block_test/src/ContextProvider/MultipleStaticContext.php

Gets all available contexts for the purposes of configuration.

File

core/modules/block/tests/modules/block_test/src/ContextProvider/MultipleStaticContext.php, line 46

Class

MultipleStaticContext

Sets multiple contexts for a static value.

Namespace

Drupal\block_test\ContextProvider

Code

public function getRuntimeContexts(array $unqualified_context_ids) {
  $current_user = $this->userStorage
    ->load($this->account
    ->id());
  $context1 = EntityContext::fromEntity($current_user, 'User A');
  $context2 = EntityContext::fromEntity($current_user, 'User B');
  $cacheability = new CacheableMetadata();
  $cacheability
    ->setCacheContexts([
    'user',
  ]);
  $context1
    ->addCacheableDependency($cacheability);
  $context2
    ->addCacheableDependency($cacheability);
  return [
    'userA' => $context1,
    'userB' => $context2,
  ];
}