Same name and namespace in other branches

1. 8.9.x core/modules/node/src/ContextProvider/NodeRouteContext.php \Drupal\node\ContextProvider\NodeRouteContext::getRuntimeContexts()
2. 10 core/modules/node/src/ContextProvider/NodeRouteContext.php \Drupal\node\ContextProvider\NodeRouteContext::getRuntimeContexts()
3. 11.x 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 = 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

File

core/modules/node/src/ContextProvider/NodeRouteContext.php, line 41

Class

NodeRouteContext

Sets the current node as a context on node routes.

Namespace

Drupal\node\ContextProvider

Code

public function getRuntimeContexts(array $unqualified_context_ids) {
    $result = [];
    $context_definition = EntityContextDefinition::create('node')->setRequired(FALSE);
    $value = NULL;
    if ($route_object = $this->routeMatch
        ->getRouteObject()) {
        $route_contexts = $route_object->getOption('parameters');
        // Check for a node revision parameter first.
        if (isset($route_contexts['node_revision']) && ($revision = $this->routeMatch
            ->getParameter('node_revision'))) {
            $value = $revision;
        }
        elseif (isset($route_contexts['node']) && ($node = $this->routeMatch
            ->getParameter('node'))) {
            $value = $node;
        }
        elseif (isset($route_contexts['node_preview']) && ($node = $this->routeMatch
            ->getParameter('node_preview'))) {
            $value = $node;
        }
        elseif ($this->routeMatch
            ->getRouteName() == 'node.add') {
            $node_type = $this->routeMatch
                ->getParameter('node_type');
            $value = Node::create([
                'type' => $node_type->id(),
            ]);
        }
    }
    $cacheability = new CacheableMetadata();
    $cacheability->setCacheContexts([
        'route',
    ]);
    $context = new Context($context_definition, $value);
    $context->addCacheableDependency($cacheability);
    $result['node'] = $context;
    return $result;
}

---