class PanelsEverywhereRouteSubscriber in Panels Everywhere 8.4

Associates a route with a Page Manager page, if it exists

Hierarchy

• class \Drupal\panels_everywhere\Routing\PanelsEverywhereRouteSubscriber extends \Drupal\page_manager\Routing\PageManagerRoutes

1 file declares its use of PanelsEverywhereRouteSubscriber

PanelsEverywhereRouteSubscriberTest.php in tests/src/Unit/Routing/PanelsEverywhereRouteSubscriberTest.php

1 string reference to 'PanelsEverywhereRouteSubscriber'

panels_everywhere.services.yml in ./panels_everywhere.services.yml

panels_everywhere.services.yml

1 service uses PanelsEverywhereRouteSubscriber

panels_everywhere.route_subscriber in ./panels_everywhere.services.yml

Drupal\panels_everywhere\Routing\PanelsEverywhereRouteSubscriber

File

src/Routing/PanelsEverywhereRouteSubscriber.php, line 26

Contains \Drupal\panels_everywhere\Routing\PanelsEverywhereRouteSubscriber.

Namespace

Drupal\panels_everywhere\Routing

class PanelsEverywhereRouteSubscriber extends PageManagerRoutes {

  /**
   * {@inheritdoc}
   */
  protected function alterRoutes(RouteCollection $collection) {
    foreach ($this->entityStorage
      ->loadMultiple() as $entity_id => $entity) {

      // If the page is disabled or if it's not set to disable route override, skip processing it.
      if (!$entity
        ->status() || !$entity
        ->getVariants()) {
        continue;
      }
      $other_variants = [];
      $panels_everywhere_variant_present = FALSE;
      foreach ($entity
        ->getVariants() as $variant_id => $variant) {
        if ($variant
          ->getVariantPluginId() != 'panels_everywhere_variant') {
          $other_variants[$variant_id] = $variant;
          continue;
        }
        $panels_everywhere_variant_present = TRUE;
        $route = $this
          ->getRouteAndCleanup($entity, $variant, $collection);
        if (is_null($route)) {
          continue;
        }
        $route
          ->setDefault('page_id', $entity
          ->id());
      }
      if ($panels_everywhere_variant_present) {
        foreach ($other_variants as $variant_id => $variant) {
          $variant_route = $this
            ->getRouteFor($entity, $variant, $collection);
          if ($variant_route) {
            $variant_route
              ->setDefault('page_id', $entity
              ->id());
          }
        }
      }
    }
  }

  /**
   * Retrieves relevant route and removes page-manager override if necessary.
   *
   * The page_manager-route for the given variant will be removed if
   * route-override is disabled, even if this will lead to a page not found.
   * This is intended as it allows other variants on the page to provide
   * the main page content.
   *
   * @param PageInterface $page
   *   A page-manager page entity.
   * @param PageVariantInterface $variant
   *   A variant on the page entity.
   * @param $collection
   *   A collection of known routeis.
   *
   * @return null|\Symfony\Component\Routing\Route
   *   Will return NULL if the variant route can not be found.
   *   Will return the variant route if route override is enabled.
   *   Will return the original route if route override is disabled.
   *   Will return NULL if the variant route is not overriding anything.
   *
   */
  protected function getRouteAndCleanup(PageInterface $page, PageVariantInterface $variant, RouteCollection $collection) {
    $page_id = $page
      ->id();
    $variant_id = $variant
      ->id();
    $route_name = "page_manager.page_view_{$page_id}_{$variant_id}";
    $variantRoute = $this
      ->getRouteFor($page, $variant, $collection);
    if (is_null($variantRoute)) {
      return NULL;
    }
    if ($variant
      ->getVariantPlugin()
      ->isRouteOverrideEnabled()) {
      return $variantRoute;
    }
    $route_name_original = $variantRoute
      ->getDefault('overridden_route_name');
    $collection
      ->remove($route_name);
    return $collection
      ->get($route_name_original);
  }

  /**
   * Retrieves the relevant route.
   *
   * @param PageInterface $page
   *   A page-manager page entity.
   * @param PageVariantInterface $variant
   *   A variant on the page entity.
   * @param $collection
   *   A collection of known routes.
   *
   * @return null|\Symfony\Component\Routing\Route
   *   The relevant route or NULL if the route could not be found.
   */
  protected function getRouteFor(PageInterface $page, PageVariantInterface $variant, RouteCollection $collection) {
    $page_id = $page
      ->id();
    $variant_id = $variant
      ->id();
    $route_name = "page_manager.page_view_{$page_id}_{$variant_id}";
    return $collection
      ->get($route_name);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
PanelsEverywhereRouteSubscriber::alterRoutes	protected	function
PanelsEverywhereRouteSubscriber::getRouteAndCleanup	protected	function	Retrieves relevant route and removes page-manager override if necessary.
PanelsEverywhereRouteSubscriber::getRouteFor	protected	function	Retrieves the relevant route.