You are here

public function OgContext::getRuntimeContexts in Organic groups 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 OgContext::getRuntimeContexts()
OgContext::getGroup in src/ContextProvider/OgContext.php
Returns the group which is relevant in the current context, if any.

File

src/ContextProvider/OgContext.php, line 75

Class

OgContext
Provides the group that best matches the current context.

Namespace

Drupal\og\ContextProvider

Code

public function getRuntimeContexts(array $unqualified_context_ids) {

  // Don't bother to resolve the group context if it is not requested.
  if (!in_array('og', $unqualified_context_ids)) {
    return [];
  }
  return [
    'og' => $this
      ->getOgContext(),
  ];
}