RouteParamContext.php in Page Manager 8

Contains \Drupal\page_manager\EventSubscriber\RouteParamContext.

Namespace

Drupal\page_manager\EventSubscriber

File

src/EventSubscriber/RouteParamContext.php

<?php

/**
 * @file
 * Contains \Drupal\page_manager\EventSubscriber\RouteParamContext.
 */
namespace Drupal\page_manager\EventSubscriber;

use Drupal\Core\Cache\CacheableMetadata;
use Drupal\Core\Plugin\Context\ContextDefinition;
use Drupal\Core\StringTranslation\StringTranslationTrait;
use Drupal\page_manager\Event\PageManagerContextEvent;
use Drupal\Core\Plugin\Context\Context;
use Drupal\Core\Routing\RouteProviderInterface;
use Drupal\page_manager\Event\PageManagerEvents;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpFoundation\RequestStack;

/**
 * Sets values from the route parameters as a context.
 */
class RouteParamContext implements EventSubscriberInterface {
  use StringTranslationTrait;

  /**
   * The route provider.
   *
   * @var \Drupal\Core\Routing\RouteProviderInterface
   */
  protected $routeProvider;

  /**
   * The request stack.
   *
   * @var \Symfony\Component\HttpFoundation\RequestStack
   */
  protected $requestStack;

  /**
   * Constructs a new CurrentUserContext.
   *
   * @param \Drupal\Core\Routing\RouteProviderInterface $route_provider
   *   The route provider.
   * @param \Symfony\Component\HttpFoundation\RequestStack $request_stack
   *   The request stack.
   */
  public function __construct(RouteProviderInterface $route_provider, RequestStack $request_stack) {
    $this->routeProvider = $route_provider;
    $this->requestStack = $request_stack;
  }

  /**
   * Adds in the current user as a context.
   *
   * @param \Drupal\page_manager\Event\PageManagerContextEvent $event
   *   The page entity context event.
   */
  public function onPageContext(PageManagerContextEvent $event) {
    $request = $this->requestStack
      ->getCurrentRequest();
    $page = $event
      ->getPage();
    $routes = $this->routeProvider
      ->getRoutesByPattern($page
      ->getPath())
      ->all();
    $route = reset($routes);
    if ($route && ($route_contexts = $route
      ->getOption('parameters'))) {
      foreach ($route_contexts as $route_context_name => $route_context) {

        // Skip this parameter.
        if ($route_context_name == 'page_manager_page_variant' || $route_context_name == 'page_manager_page') {
          continue;
        }
        $parameter = $page
          ->getParameter($route_context_name);
        $context_name = !empty($parameter['label']) ? $parameter['label'] : $this
          ->t('{@name} from route', [
          '@name' => $route_context_name,
        ]);
        if ($request->attributes
          ->has($route_context_name)) {
          $value = $request->attributes
            ->get($route_context_name);
        }
        else {
          $value = NULL;
        }
        $cacheability = new CacheableMetadata();
        $cacheability
          ->setCacheContexts([
          'route',
        ]);
        $context = new Context(new ContextDefinition($route_context['type'], $context_name, FALSE), $value);
        $context
          ->addCacheableDependency($cacheability);
        $page
          ->addContext($route_context_name, $context);
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public static function getSubscribedEvents() {
    $events[PageManagerEvents::PAGE_CONTEXT][] = 'onPageContext';
    return $events;
  }

}

Classes

Name	Description
RouteParamContext	Sets values from the route parameters as a context.