public function SiteContext::getRuntimeContexts in Rules 8.3

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 SiteContext::getRuntimeContexts()

SiteContext::getAvailableContexts in src/ContextProvider/SiteContext.php

Gets all available contexts for the purposes of configuration.

File

src/ContextProvider/SiteContext.php, line 46

Class

SiteContext

Sets the current node as a context on node routes.

Namespace

Drupal\rules\ContextProvider

Code

public function getRuntimeContexts(array $unqualified_context_ids) {
  $site = [
    'url' => Url::fromRoute('<front>', [], [
      'absolute' => TRUE,
    ])
      ->toString(),
    'login-url' => Url::fromRoute('user.page', [], [
      'absolute' => TRUE,
    ])
      ->toString(),
    'name' => $this->systemSiteConfig
      ->get('name'),
    'slogan' => $this->systemSiteConfig
      ->get('slogan'),
    'mail' => $this->systemSiteConfig
      ->get('mail'),
  ];
  $context_definition = new ContextDefinition('site', $this
    ->t('Site information'));
  $context = new Context($context_definition, $site);
  $cacheability = new CacheableMetadata();
  $cacheability
    ->setCacheContexts([
    'site',
  ]);
  $context
    ->addCacheableDependency($cacheability);
  $result = [
    'site' => $context,
  ];
  return $result;
}