public function GroupRouteContext::getRuntimeContexts in Group 8

Same name and namespace in other branches

1. 2.0.x src/Context/GroupRouteContext.php \Drupal\group\Context\GroupRouteContext::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

src/Context/GroupRouteContext.php, line 42

Class

GroupRouteContext

Sets the current group as a context on group routes.

Namespace

Drupal\group\Context

Code

public function getRuntimeContexts(array $unqualified_context_ids) {

  // Create an optional context definition for group entities.
  $context_definition = EntityContextDefinition::fromEntityTypeId('group')
    ->setRequired(FALSE);

  // Cache this context per group on the route.
  $cacheability = new CacheableMetadata();
  $cacheability
    ->setCacheContexts([
    'route.group',
  ]);

  // Create a context from the definition and retrieved or created group.
  $context = new Context($context_definition, $this
    ->getGroupFromRoute());
  $context
    ->addCacheableDependency($cacheability);
  return [
    'group' => $context,
  ];
}