public function CurrentDomainContext::getRuntimeContexts in Domain Access 8

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()

1 call to CurrentDomainContext::getRuntimeContexts()

CurrentDomainContext::getAvailableContexts in domain/src/ContextProvider/CurrentDomainContext.php

Gets all available contexts for the purposes of configuration.

File

domain/src/ContextProvider/CurrentDomainContext.php, line 40

Class

CurrentDomainContext

Provides a context handler for the block system.

Namespace

Drupal\domain\ContextProvider

Code

public function getRuntimeContexts(array $unqualified_context_ids) {
  $context = NULL;

  // Load the current domain.
  $current_domain = $this->negotiator
    ->getActiveDomain();

  // Set the context, if we have a domain.
  if (!empty($current_domain) && !empty($current_domain
    ->id())) {
    $context = EntityContext::fromEntity($current_domain, $this
      ->t('Active domain'));

    // Allow caching.
    $cacheability = new CacheableMetadata();
    $cacheability
      ->setCacheContexts([
      'url.site',
    ]);
    $context
      ->addCacheableDependency($cacheability);
  }

  // Prepare the result.
  $result = [
    'domain' => $context,
  ];
  return $result;
}