public function CurrentUserContext::getRuntimeContexts in Drupal 8

Same name and namespace in other branches

1. 9 core/modules/user/src/ContextProvider/CurrentUserContext.php \Drupal\user\ContextProvider\CurrentUserContext::getRuntimeContexts()
2. 10 core/modules/user/src/ContextProvider/CurrentUserContext.php \Drupal\user\ContextProvider\CurrentUserContext::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()

1 call to CurrentUserContext::getRuntimeContexts()

CurrentUserContext::getAvailableContexts in core/modules/user/src/ContextProvider/CurrentUserContext.php

Gets all available contexts for the purposes of configuration.

File

core/modules/user/src/ContextProvider/CurrentUserContext.php, line 49

Class

CurrentUserContext

Sets the current user as a context.

Namespace

Drupal\user\ContextProvider

Code

public function getRuntimeContexts(array $unqualified_context_ids) {
  $current_user = $this->userStorage
    ->load($this->account
    ->id());
  if ($current_user) {

    // @todo Do not validate protected fields to avoid bug in TypedData,
    //   remove this in https://www.drupal.org/project/drupal/issues/2934192.
    $current_user->_skipProtectedUserFieldConstraint = TRUE;
    $context = EntityContext::fromEntity($current_user, $this
      ->t('Current user'));
  }
  else {

    // If not user is available, provide an empty context object.
    $context = EntityContext::fromEntityTypeId('user', $this
      ->t('Current user'));
  }
  $cacheability = new CacheableMetadata();
  $cacheability
    ->setCacheContexts([
    'user',
  ]);
  $context
    ->addCacheableDependency($cacheability);
  $result = [
    'current_user' => $context,
  ];
  return $result;
}