public function NodeRouteContext::getRuntimeContexts in Zircon Profile 8
Same name and namespace in other branches
- 8.0 core/modules/node/src/ContextProvider/NodeRouteContext.php \Drupal\node\ContextProvider\NodeRouteContext::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 = new Context(new ContextDefinition('entity:node'), $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/ node/ src/ ContextProvider/ NodeRouteContext.php, line 45 - Contains \Drupal\node\ContextProvider\NodeRouteContext.
Class
- NodeRouteContext
- Sets the current node as a context on node routes.
Namespace
Drupal\node\ContextProviderCode
public function getRuntimeContexts(array $unqualified_context_ids) {
$result = [];
$context_definition = new ContextDefinition('entity:node', NULL, FALSE);
$value = NULL;
if (($route_object = $this->routeMatch
->getRouteObject()) && ($route_contexts = $route_object
->getOption('parameters')) && isset($route_contexts['node'])) {
if ($node = $this->routeMatch
->getParameter('node')) {
$value = $node;
}
}
elseif ($this->routeMatch
->getRouteName() == 'node.add') {
$node_type = $this->routeMatch
->getParameter('node_type');
$value = Node::create(array(
'type' => $node_type
->id(),
));
}
$cacheability = new CacheableMetadata();
$cacheability
->setCacheContexts([
'route',
]);
$context = new Context($context_definition, $value);
$context
->addCacheableDependency($cacheability);
$result['node'] = $context;
return $result;
}