public function WebformRouteContext::getRuntimeContexts in Webform 6.x

Same name and namespace in other branches

1. 8.5 src/ContextProvider/WebformRouteContext.php \Drupal\webform\ContextProvider\WebformRouteContext::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/ContextProvider/WebformRouteContext.php, line 40

Class

WebformRouteContext

Sets the current webform as a context on webform routes.

Namespace

Drupal\webform\ContextProvider

Code

public function getRuntimeContexts(array $unqualified_context_ids) {
  $context_definition = EntityContextDefinition::fromEntityTypeId('webform')
    ->setLabel(NULL)
    ->setRequired(FALSE);
  $value = NULL;
  if (($route_object = $this->routeMatch
    ->getRouteObject()) && ($route_contexts = $route_object
    ->getOption('parameters')) && isset($route_contexts['webform'])) {
    if ($webform = $this->routeMatch
      ->getParameter('webform')) {
      $value = $webform;
    }
  }
  $cacheability = new CacheableMetadata();
  $cacheability
    ->setCacheContexts([
    'route',
  ]);
  $context = new Context($context_definition, $value);
  $context
    ->addCacheableDependency($cacheability);
  return [
    'webform' => $context,
  ];
}