public function UserRouteContext::getRuntimeContexts in Open Social 8.7

Same name and namespace in other branches

1. 8.9 modules/social_features/social_user/src/ContextProvider/UserRouteContext.php \Drupal\social_user\ContextProvider\UserRouteContext::getRuntimeContexts()
2. 8 modules/social_features/social_user/src/ContextProvider/UserRouteContext.php \Drupal\social_user\ContextProvider\UserRouteContext::getRuntimeContexts()
3. 8.2 modules/social_features/social_user/src/ContextProvider/UserRouteContext.php \Drupal\social_user\ContextProvider\UserRouteContext::getRuntimeContexts()
4. 8.3 modules/social_features/social_user/src/ContextProvider/UserRouteContext.php \Drupal\social_user\ContextProvider\UserRouteContext::getRuntimeContexts()
5. 8.4 modules/social_features/social_user/src/ContextProvider/UserRouteContext.php \Drupal\social_user\ContextProvider\UserRouteContext::getRuntimeContexts()
6. 8.5 modules/social_features/social_user/src/ContextProvider/UserRouteContext.php \Drupal\social_user\ContextProvider\UserRouteContext::getRuntimeContexts()
7. 8.6 modules/social_features/social_user/src/ContextProvider/UserRouteContext.php \Drupal\social_user\ContextProvider\UserRouteContext::getRuntimeContexts()
8. 8.8 modules/social_features/social_user/src/ContextProvider/UserRouteContext.php \Drupal\social_user\ContextProvider\UserRouteContext::getRuntimeContexts()
9. 10.3.x modules/social_features/social_user/src/ContextProvider/UserRouteContext.php \Drupal\social_user\ContextProvider\UserRouteContext::getRuntimeContexts()
10. 10.0.x modules/social_features/social_user/src/ContextProvider/UserRouteContext.php \Drupal\social_user\ContextProvider\UserRouteContext::getRuntimeContexts()
11. 10.1.x modules/social_features/social_user/src/ContextProvider/UserRouteContext.php \Drupal\social_user\ContextProvider\UserRouteContext::getRuntimeContexts()
12. 10.2.x modules/social_features/social_user/src/ContextProvider/UserRouteContext.php \Drupal\social_user\ContextProvider\UserRouteContext::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 UserRouteContext::getRuntimeContexts()

UserRouteContext::getAvailableContexts in modules/social_features/social_user/src/ContextProvider/UserRouteContext.php

Gets all available contexts for the purposes of configuration.

File

modules/social_features/social_user/src/ContextProvider/UserRouteContext.php, line 53

Class

UserRouteContext

Class UserRouteContext.

Namespace

Drupal\social_user\ContextProvider

Code

public function getRuntimeContexts(array $unqualified_context_ids) {

  // Create an optional context definition for user entities.
  $context_definition = new ContextDefinition('entity:user', $this
    ->t('User from URL'), FALSE);

  // Cache this context on the route.
  $cacheability = new CacheableMetadata();
  $cacheability
    ->setCacheContexts([
    'route',
  ]);

  // Create a context from the definition and retrieved user.
  $context = new Context($context_definition, $this
    ->getUserFromRoute());
  $context
    ->addCacheableDependency($cacheability);
  return [
    'user' => $context,
  ];
}