public function TestNodeContext::getRuntimeContexts in Component blocks 1.0.x
Same name and namespace in other branches
- 1.x tests/modules/component_blocks_test/src/TestNodeContext.php \Drupal\component_blocks_test\TestNodeContext::getRuntimeContexts()
- 1.1.x tests/modules/component_blocks_test/src/TestNodeContext.php \Drupal\component_blocks_test\TestNodeContext::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
- tests/
modules/ component_blocks_test/ src/ TestNodeContext.php, line 27
Class
- TestNodeContext
- Defines a class for a test node context.
Namespace
Drupal\component_blocks_testCode
public function getRuntimeContexts(array $unqualified_context_ids) {
$result = [];
$context_definition = EntityContextDefinition::create('node')
->setRequired(FALSE);
$cacheability = new CacheableMetadata();
$cacheability
->setCacheContexts([
'route',
])
->setCacheMaxAge(0);
$context = new Context($context_definition, $this->node);
$context
->addCacheableDependency($cacheability);
$result['node'] = $context;
return $result;
}