public function IHaveRuntimeContexts::getRuntimeContexts in Drupal 10

Same name and namespace in other branches

1. 9 core/modules/layout_builder/tests/modules/layout_builder_test/src/ContextProvider/IHaveRuntimeContexts.php \Drupal\layout_builder_test\ContextProvider\IHaveRuntimeContexts::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()

File

core/modules/layout_builder/tests/modules/layout_builder_test/src/ContextProvider/IHaveRuntimeContexts.php, line 17

Class

IHaveRuntimeContexts

Defines a class for a fake context provider.

Namespace

Drupal\layout_builder_test\ContextProvider

Code

public function getRuntimeContexts(array $unqualified_context_ids) {
  return [
    'runtime_contexts' => new Context(new ContextDefinition('string', 'Do you have runtime contexts?'), 'for sure you can'),
  ];
}