Same name and namespace in other branches

1. 9 core/modules/taxonomy/src/ContextProvider/TermRouteContext.php \Drupal\taxonomy\ContextProvider\TermRouteContext::getRuntimeContexts()
2. 11.x core/modules/taxonomy/src/ContextProvider/TermRouteContext.php \Drupal\taxonomy\ContextProvider\TermRouteContext::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/taxonomy/src/ContextProvider/TermRouteContext.php, line 41

Class

TermRouteContext

Sets the current taxonomy term as a context on taxonomy term routes.

Namespace

Drupal\taxonomy\ContextProvider

Code

public function getRuntimeContexts(array $unqualified_context_ids) {
    $result = [];
    $context_definition = EntityContextDefinition::create('taxonomy_term')->setRequired(FALSE);
    $value = NULL;
    if ($route_object = $this->routeMatch
        ->getRouteObject()) {
        $route_parameters = $route_object->getOption('parameters');
        if (isset($route_parameters['taxonomy_term']) && ($term = $this->routeMatch
            ->getParameter('taxonomy_term'))) {
            $value = $term;
        }
        elseif ($this->routeMatch
            ->getRouteName() == 'entity.taxonomy_term.add_form') {
            $vocabulary = $this->routeMatch
                ->getParameter('taxonomy_vocabulary');
            $value = Term::create([
                'vid' => $vocabulary->id(),
            ]);
        }
    }
    $cacheability = new CacheableMetadata();
    $cacheability->setCacheContexts([
        'route',
    ]);
    $context = new Context($context_definition, $value);
    $context->addCacheableDependency($cacheability);
    $result['taxonomy_term'] = $context;
    return $result;
}

---