yaffs.net Git - yaffs-website/blob - web/modules/contrib/devel/src/Routing/RouteSubscriber.php

   1 <?php
   2
   3 namespace Drupal\devel\Routing;
   4
   5 use Drupal\Core\Entity\EntityTypeInterface;
   6 use Drupal\Core\Entity\EntityTypeManagerInterface;
   7 use Drupal\Core\Routing\RouteSubscriberBase;
   8 use Drupal\Core\Routing\RoutingEvents;
   9 use Symfony\Component\Routing\Route;
  10 use Symfony\Component\Routing\RouteCollection;
  11
  12 /**
  13  * Subscriber for Devel routes.
  14  *
  15  * @see \Drupal\devel\Controller\EntityDebugController
  16  * @see \Drupal\devel\Plugin\Derivative\DevelLocalTask
  17  */
  18 class RouteSubscriber extends RouteSubscriberBase {
  19
  20   /**
  21    * The entity type manager service.
  22    *
  23    * @var \Drupal\Core\Entity\EntityTypeManagerInterface
  24    */
  25   protected $entityTypeManager;
  26
  27   /**
  28    * Constructs a new RouteSubscriber object.
  29    *
  30    * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_manager
  31    *   The entity type manager.
  32    */
  33   public function __construct(EntityTypeManagerInterface $entity_manager) {
  34     $this->entityTypeManager = $entity_manager;
  35   }
  36
  37   /**
  38    * {@inheritdoc}
  39    */
  40   protected function alterRoutes(RouteCollection $collection) {
  41     foreach ($this->entityTypeManager->getDefinitions() as $entity_type_id => $entity_type) {
  42       if ($route = $this->getEntityLoadRoute($entity_type)) {
  43         $collection->add("entity.$entity_type_id.devel_load", $route);
  44       }
  45       if ($route = $this->getEntityRenderRoute($entity_type)) {
  46         $collection->add("entity.$entity_type_id.devel_render", $route);
  47       }
  48       if ($route = $this->getEntityTypeDefinitionRoute($entity_type)) {
  49         $collection->add("entity.$entity_type_id.devel_definition", $route);
  50       }
  51     }
  52   }
  53
  54   /**
  55    * Gets the entity load route.
  56    *
  57    * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
  58    *   The entity type.
  59    *
  60    * @return \Symfony\Component\Routing\Route|null
  61    *   The generated route, if available.
  62    */
  63   protected function getEntityLoadRoute(EntityTypeInterface $entity_type) {
  64     if ($devel_load = $entity_type->getLinkTemplate('devel-load')) {
  65       $entity_type_id = $entity_type->id();
  66       $route = new Route($devel_load);
  67       $route
  68         ->addDefaults([
  69           '_controller' => '\Drupal\devel\Controller\EntityDebugController::entityLoad',
  70           '_title' => 'Devel Load',
  71         ])
  72         ->addRequirements([
  73           '_permission' => 'access devel information',
  74         ])
  75         ->setOption('_admin_route', TRUE)
  76         ->setOption('_devel_entity_type_id', $entity_type_id)
  77         ->setOption('parameters', [
  78           $entity_type_id => ['type' => 'entity:' . $entity_type_id],
  79         ]);
  80
  81       return $route;
  82     }
  83   }
  84
  85   /**
  86    * Gets the entity render route.
  87    *
  88    * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
  89    *   The entity type.
  90    *
  91    * @return \Symfony\Component\Routing\Route|null
  92    *   The generated route, if available.
  93    */
  94   protected function getEntityRenderRoute(EntityTypeInterface $entity_type) {
  95     if ($devel_render = $entity_type->getLinkTemplate('devel-render')) {
  96       $entity_type_id = $entity_type->id();
  97       $route = new Route($devel_render);
  98       $route
  99         ->addDefaults([
 100           '_controller' => '\Drupal\devel\Controller\EntityDebugController::entityRender',
 101           '_title' => 'Devel Render',
 102         ])
 103         ->addRequirements([
 104           '_permission' => 'access devel information'
 105         ])
 106         ->setOption('_admin_route', TRUE)
 107         ->setOption('_devel_entity_type_id', $entity_type_id)
 108         ->setOption('parameters', [
 109           $entity_type_id => ['type' => 'entity:' . $entity_type_id],
 110         ]);
 111
 112       return $route;
 113     }
 114   }
 115
 116   /**
 117    * Gets the entity type definition route.
 118    *
 119    * @param \Drupal\Core\Entity\EntityTypeInterface $entity_type
 120    *   The entity type.
 121    *
 122    * @return \Symfony\Component\Routing\Route|null
 123    *   The generated route, if available.
 124    */
 125   protected function getEntityTypeDefinitionRoute(EntityTypeInterface $entity_type) {
 126     if ($devel_definition = $entity_type->getLinkTemplate('devel-definition')) {
 127       $entity_type_id = $entity_type->id();
 128       $route = new Route($devel_definition);
 129       $route
 130         ->addDefaults([
 131           '_controller' => '\Drupal\devel\Controller\EntityDebugController::entityTypeDefinition',
 132           '_title' => 'Entity type definition',
 133         ])
 134         ->addRequirements([
 135           '_permission' => 'access devel information'
 136         ])
 137         ->setOption('_admin_route', TRUE)
 138         ->setOption('_devel_entity_type_id', $entity_type_id)
 139         ->setOption('parameters', [
 140           $entity_type_id => ['type' => 'entity:' . $entity_type_id],
 141         ]);
 142
 143       return $route;
 144     }
 145   }
 146
 147   /**
 148    * {@inheritdoc}
 149    */
 150   public static function getSubscribedEvents() {
 151     $events = parent::getSubscribedEvents();
 152     $events[RoutingEvents::ALTER] = ['onAlterRoutes', 100];
 153     return $events;
 154   }
 155
 156 }