public function ProductRouteContext::getRuntimeContexts in Commerce Core 8.2

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

modules/product/src/ContextProvider/ProductRouteContext.php, line 53

Class

ProductRouteContext: Sets the current product as context on commerce_product routes.

Namespace

Drupal\commerce_product\ContextProvider

Code

public function getRuntimeContexts(array $unqualified_context_ids) {
  $context_definition = new EntityContextDefinition('entity:commerce_product', NULL, FALSE);
  $value = NULL;
  if ($product = $this->routeMatch
    ->getParameter('commerce_product')) {
    $value = $product;
  }
  elseif ($product_type = $this->routeMatch
    ->getParameter('commerce_product_type')) {
    $product_storage = $this->entityTypeManager
      ->getStorage('commerce_product');
    $product_type_id = $product_type instanceof ProductTypeInterface ? $product_type
      ->id() : $product_type;
    $value = $product_storage
      ->createWithSampleValues($product_type_id);
  }
  $cacheability = new CacheableMetadata();
  $cacheability
    ->setCacheContexts([
    'route',
  ]);
  $context = new Context($context_definition, $value);
  $context
    ->addCacheableDependency($cacheability);
  return [
    'commerce_product' => $context,
  ];
}

You are here