public function OverridesSectionStorage::deriveContextsFromRoute in Drupal 9

Same name and namespace in other branches

1. 8 core/modules/layout_builder/src/Plugin/SectionStorage/OverridesSectionStorage.php \Drupal\layout_builder\Plugin\SectionStorage\OverridesSectionStorage::deriveContextsFromRoute()

Derives the available plugin contexts from route values.

This should only be called during section storage instantiation, specifically for use by the routing system. For all non-routing usages, use \Drupal\Component\Plugin\ContextAwarePluginInterface::getContextValue().

Parameters

mixed $value: The raw value.

mixed $definition: The parameter definition provided in the route options.

string $name: The name of the parameter.

array $defaults: The route defaults array.

Return value

\Drupal\Core\Plugin\Context\ContextInterface[] The available plugin contexts.

Overrides SectionStorageInterface::deriveContextsFromRoute

See also

\Drupal\Core\ParamConverter\ParamConverterInterface::convert()

File

core/modules/layout_builder/src/Plugin/SectionStorage/OverridesSectionStorage.php, line 166

Class

OverridesSectionStorage

Defines the 'overrides' section storage type.

Namespace

Drupal\layout_builder\Plugin\SectionStorage

Code

public function deriveContextsFromRoute($value, $definition, $name, array $defaults) {
  $contexts = [];
  if ($entity = $this
    ->extractEntityFromRoute($value, $defaults)) {
    $contexts['entity'] = EntityContext::fromEntity($entity);

    // @todo Expand to work for all view modes in
    //   https://www.drupal.org/node/2907413.
    $view_mode = 'full';

    // Retrieve the actual view mode from the returned view display as the
    // requested view mode may not exist and a fallback will be used.
    $view_mode = LayoutBuilderEntityViewDisplay::collectRenderDisplay($entity, $view_mode)
      ->getMode();
    $contexts['view_mode'] = new Context(new ContextDefinition('string'), $view_mode);
  }
  return $contexts;
}