1	<?php
2
3	declare(strict_types=1);
4
5	namespace Drupal\display_builder_entity_view\Routing;
6
7	use Drupal\Core\Entity\EntityTypeManagerInterface;
8	use Drupal\Core\Routing\RouteBuildEvent;
9	use Drupal\Core\Routing\RoutingEvents;
10	use Drupal\display_builder_entity_view\Controller\EntityViewOverridesController;
11	use Drupal\display_builder_entity_view\Entity\EntityViewDisplay;
12	use Symfony\Component\DependencyInjection\ContainerInterface;
13	use Symfony\Component\EventDispatcher\EventSubscriberInterface;
14	use Symfony\Component\Routing\Route;
15	use Symfony\Component\Routing\RouteCollection;
16
17	/**
18	* Provides routes for the Display Builder UI.
19	*
20	* @internal
21	*   Tagged services are internal.
22	*/
23	final class OverridesRoutes implements EventSubscriberInterface {
24
25	/**
26	* {@inheritdoc}
27	*/
28	public function __construct(
29	private EntityTypeManagerInterface $entityTypeManager,
30	) {}
31
32	/**
33	* {@inheritdoc}
34	*/
35	public static function create(ContainerInterface $container): static {
36	return new self(
37	$container->get('entity_type.manager'),
38	);
39	}
40
41	/**
42	* {@inheritdoc}
43	*/
44	public static function getSubscribedEvents(): array {
45	$events = [];
46	// Run after \Drupal\field_ui\Routing\RouteSubscriber.
47	$events[RoutingEvents::ALTER] = ['onAlterRoutes', -110];
48
49	return $events;
50	}
51
52	/**
53	* Alters existing routes for a specific collection.
54	*
55	* @param \Drupal\Core\Routing\RouteBuildEvent $event
56	*   The route build event.
57	*/
58	public function onAlterRoutes(RouteBuildEvent $event): void {
59	$collection = $event->getRouteCollection();
60	$this->buildRoutes($collection);
61	}
62
63	/**
64	* Build routes for each display overrides.
65	*
66	* @param \Symfony\Component\Routing\RouteCollection $collection
67	*   The route collection to add the routes to.
68	*/
69	private function buildRoutes(RouteCollection $collection): void {
70	$display_infos = EntityViewDisplay::getDisplayInfos($this->entityTypeManager);
71
72	foreach ($display_infos as $entity_type_id => $display_info) {
73	$entity_type = $this->entityTypeManager->getDefinition($entity_type_id);
74	$canonical = $entity_type->getLinkTemplate('canonical');
75
76	$path = \sprintf('%s/display', $canonical);
77	$forward_route = $this->buildSingleRoute($entity_type_id, $path, 'getFirstBuilder', 'checkFirstBuilderAccess');
78	$collection->add("entity.{$entity_type_id}.display_builder.forward", $forward_route);
79
80	foreach (\array_keys($display_info['modes']) as $view_mode) {
81	$path = \sprintf('%s/display/%s', $canonical, $view_mode);
82	$override_route = $this->buildSingleRoute($entity_type_id, $path, 'getBuilder', 'checkAccess');
83	$override_route->addDefaults(['view_mode_name' => $view_mode]);
84	$collection->add("entity.{$entity_type_id}.display_builder.{$view_mode}", $override_route);
85	}
86	}
87	}
88
89	/**
90	* Build single display overrides route.
91	*
92	* @param string $entity_type_id
93	*   The entity type ID.
94	* @param string $path
95	*   The path for the route.
96	* @param string $controller
97	*   The controller method to call.
98	* @param string $custom_access
99	*   The custom access check method.
100	*
101	* @return \Symfony\Component\Routing\Route
102	*   The built route.
103	*/
104	private function buildSingleRoute(string $entity_type_id, string $path, string $controller, string $custom_access): Route {
105	$defaults = [
106	'_controller' => EntityViewOverridesController::class . '::' . $controller,
107	'_title_callback' => EntityViewOverridesController::class . '::title',
108	'entity_type_id' => $entity_type_id,
109	];
110	$requirements = [
111	'_entity_access' => "{$entity_type_id}.update",
112	'_custom_access' => EntityViewOverridesController::class . '::' . $custom_access,
113	];
114	$main_options = [
115	'parameters' => [
116	$entity_type_id => ['type' => 'entity:' . $entity_type_id],
117	],
118	];
119
120	return (new Route($path))
121	->setDefaults($defaults)
122	->setRequirements($requirements)
123	->setOptions($main_options);
124	}
125
126	}

---

Paths

Below are the source code lines that represent each code path as identified by Xdebug. Please note a path is not necessarily coterminous with a line, a line may contain multiple paths and therefore show up more than once. Please also be aware that some paths may include implicit rather than explicit branches, e.g. an if statement always has an else as part of its logical flow even if you didn't write one.

OverridesRoutes->__construct

28	public function __construct(
29	private EntityTypeManagerInterface $entityTypeManager,
30	) {}

OverridesRoutes->buildRoutes

69	private function buildRoutes(RouteCollection $collection): void {
70	$display_infos = EntityViewDisplay::getDisplayInfos($this->entityTypeManager);
71
72	foreach ($display_infos as $entity_type_id => $display_info) {
72	foreach ($display_infos as $entity_type_id => $display_info) {
72	foreach ($display_infos as $entity_type_id => $display_info) {
73	$entity_type = $this->entityTypeManager->getDefinition($entity_type_id);
74	$canonical = $entity_type->getLinkTemplate('canonical');
75
76	$path = \sprintf('%s/display', $canonical);
77	$forward_route = $this->buildSingleRoute($entity_type_id, $path, 'getFirstBuilder', 'checkFirstBuilderAccess');
78	$collection->add("entity.{$entity_type_id}.display_builder.forward", $forward_route);
79
80	foreach (\array_keys($display_info['modes']) as $view_mode) {
80	foreach (\array_keys($display_info['modes']) as $view_mode) {
80	foreach (\array_keys($display_info['modes']) as $view_mode) {
81	$path = \sprintf('%s/display/%s', $canonical, $view_mode);
80	foreach (\array_keys($display_info['modes']) as $view_mode) {
72	foreach ($display_infos as $entity_type_id => $display_info) {
73	$entity_type = $this->entityTypeManager->getDefinition($entity_type_id);
74	$canonical = $entity_type->getLinkTemplate('canonical');
75
76	$path = \sprintf('%s/display', $canonical);
77	$forward_route = $this->buildSingleRoute($entity_type_id, $path, 'getFirstBuilder', 'checkFirstBuilderAccess');
78	$collection->add("entity.{$entity_type_id}.display_builder.forward", $forward_route);
79
80	foreach (\array_keys($display_info['modes']) as $view_mode) {
72	foreach ($display_infos as $entity_type_id => $display_info) {
72	foreach ($display_infos as $entity_type_id => $display_info) {
73	$entity_type = $this->entityTypeManager->getDefinition($entity_type_id);
74	$canonical = $entity_type->getLinkTemplate('canonical');
75
76	$path = \sprintf('%s/display', $canonical);
77	$forward_route = $this->buildSingleRoute($entity_type_id, $path, 'getFirstBuilder', 'checkFirstBuilderAccess');
78	$collection->add("entity.{$entity_type_id}.display_builder.forward", $forward_route);
79
80	foreach (\array_keys($display_info['modes']) as $view_mode) {
81	$path = \sprintf('%s/display/%s', $canonical, $view_mode);
82	$override_route = $this->buildSingleRoute($entity_type_id, $path, 'getBuilder', 'checkAccess');
83	$override_route->addDefaults(['view_mode_name' => $view_mode]);
84	$collection->add("entity.{$entity_type_id}.display_builder.{$view_mode}", $override_route);
85	}
86	}
87	}

69	private function buildRoutes(RouteCollection $collection): void {
70	$display_infos = EntityViewDisplay::getDisplayInfos($this->entityTypeManager);
71
72	foreach ($display_infos as $entity_type_id => $display_info) {
72	foreach ($display_infos as $entity_type_id => $display_info) {
72	foreach ($display_infos as $entity_type_id => $display_info) {
73	$entity_type = $this->entityTypeManager->getDefinition($entity_type_id);
74	$canonical = $entity_type->getLinkTemplate('canonical');
75
76	$path = \sprintf('%s/display', $canonical);
77	$forward_route = $this->buildSingleRoute($entity_type_id, $path, 'getFirstBuilder', 'checkFirstBuilderAccess');
78	$collection->add("entity.{$entity_type_id}.display_builder.forward", $forward_route);
79
80	foreach (\array_keys($display_info['modes']) as $view_mode) {
80	foreach (\array_keys($display_info['modes']) as $view_mode) {
72	foreach ($display_infos as $entity_type_id => $display_info) {
73	$entity_type = $this->entityTypeManager->getDefinition($entity_type_id);
74	$canonical = $entity_type->getLinkTemplate('canonical');
75
76	$path = \sprintf('%s/display', $canonical);
77	$forward_route = $this->buildSingleRoute($entity_type_id, $path, 'getFirstBuilder', 'checkFirstBuilderAccess');
78	$collection->add("entity.{$entity_type_id}.display_builder.forward", $forward_route);
79
80	foreach (\array_keys($display_info['modes']) as $view_mode) {
72	foreach ($display_infos as $entity_type_id => $display_info) {
72	foreach ($display_infos as $entity_type_id => $display_info) {
73	$entity_type = $this->entityTypeManager->getDefinition($entity_type_id);
74	$canonical = $entity_type->getLinkTemplate('canonical');
75
76	$path = \sprintf('%s/display', $canonical);
77	$forward_route = $this->buildSingleRoute($entity_type_id, $path, 'getFirstBuilder', 'checkFirstBuilderAccess');
78	$collection->add("entity.{$entity_type_id}.display_builder.forward", $forward_route);
79
80	foreach (\array_keys($display_info['modes']) as $view_mode) {
81	$path = \sprintf('%s/display/%s', $canonical, $view_mode);
82	$override_route = $this->buildSingleRoute($entity_type_id, $path, 'getBuilder', 'checkAccess');
83	$override_route->addDefaults(['view_mode_name' => $view_mode]);
84	$collection->add("entity.{$entity_type_id}.display_builder.{$view_mode}", $override_route);
85	}
86	}
87	}

69	private function buildRoutes(RouteCollection $collection): void {
70	$display_infos = EntityViewDisplay::getDisplayInfos($this->entityTypeManager);
71
72	foreach ($display_infos as $entity_type_id => $display_info) {
72	foreach ($display_infos as $entity_type_id => $display_info) {
72	foreach ($display_infos as $entity_type_id => $display_info) {
73	$entity_type = $this->entityTypeManager->getDefinition($entity_type_id);
74	$canonical = $entity_type->getLinkTemplate('canonical');
75
76	$path = \sprintf('%s/display', $canonical);
77	$forward_route = $this->buildSingleRoute($entity_type_id, $path, 'getFirstBuilder', 'checkFirstBuilderAccess');
78	$collection->add("entity.{$entity_type_id}.display_builder.forward", $forward_route);
79
80	foreach (\array_keys($display_info['modes']) as $view_mode) {
72	foreach ($display_infos as $entity_type_id => $display_info) {
73	$entity_type = $this->entityTypeManager->getDefinition($entity_type_id);
74	$canonical = $entity_type->getLinkTemplate('canonical');
75
76	$path = \sprintf('%s/display', $canonical);
77	$forward_route = $this->buildSingleRoute($entity_type_id, $path, 'getFirstBuilder', 'checkFirstBuilderAccess');
78	$collection->add("entity.{$entity_type_id}.display_builder.forward", $forward_route);
79
80	foreach (\array_keys($display_info['modes']) as $view_mode) {
72	foreach ($display_infos as $entity_type_id => $display_info) {
72	foreach ($display_infos as $entity_type_id => $display_info) {
73	$entity_type = $this->entityTypeManager->getDefinition($entity_type_id);
74	$canonical = $entity_type->getLinkTemplate('canonical');
75
76	$path = \sprintf('%s/display', $canonical);
77	$forward_route = $this->buildSingleRoute($entity_type_id, $path, 'getFirstBuilder', 'checkFirstBuilderAccess');
78	$collection->add("entity.{$entity_type_id}.display_builder.forward", $forward_route);
79
80	foreach (\array_keys($display_info['modes']) as $view_mode) {
81	$path = \sprintf('%s/display/%s', $canonical, $view_mode);
82	$override_route = $this->buildSingleRoute($entity_type_id, $path, 'getBuilder', 'checkAccess');
83	$override_route->addDefaults(['view_mode_name' => $view_mode]);
84	$collection->add("entity.{$entity_type_id}.display_builder.{$view_mode}", $override_route);
85	}
86	}
87	}

69	private function buildRoutes(RouteCollection $collection): void {
70	$display_infos = EntityViewDisplay::getDisplayInfos($this->entityTypeManager);
71
72	foreach ($display_infos as $entity_type_id => $display_info) {
72	foreach ($display_infos as $entity_type_id => $display_info) {
72	foreach ($display_infos as $entity_type_id => $display_info) {
73	$entity_type = $this->entityTypeManager->getDefinition($entity_type_id);
74	$canonical = $entity_type->getLinkTemplate('canonical');
75
76	$path = \sprintf('%s/display', $canonical);
77	$forward_route = $this->buildSingleRoute($entity_type_id, $path, 'getFirstBuilder', 'checkFirstBuilderAccess');
78	$collection->add("entity.{$entity_type_id}.display_builder.forward", $forward_route);
79
80	foreach (\array_keys($display_info['modes']) as $view_mode) {
81	$path = \sprintf('%s/display/%s', $canonical, $view_mode);
82	$override_route = $this->buildSingleRoute($entity_type_id, $path, 'getBuilder', 'checkAccess');
83	$override_route->addDefaults(['view_mode_name' => $view_mode]);
84	$collection->add("entity.{$entity_type_id}.display_builder.{$view_mode}", $override_route);
85	}
86	}
87	}

69	private function buildRoutes(RouteCollection $collection): void {
70	$display_infos = EntityViewDisplay::getDisplayInfos($this->entityTypeManager);
71
72	foreach ($display_infos as $entity_type_id => $display_info) {
72	foreach ($display_infos as $entity_type_id => $display_info) {
73	$entity_type = $this->entityTypeManager->getDefinition($entity_type_id);
74	$canonical = $entity_type->getLinkTemplate('canonical');
75
76	$path = \sprintf('%s/display', $canonical);
77	$forward_route = $this->buildSingleRoute($entity_type_id, $path, 'getFirstBuilder', 'checkFirstBuilderAccess');
78	$collection->add("entity.{$entity_type_id}.display_builder.forward", $forward_route);
79
80	foreach (\array_keys($display_info['modes']) as $view_mode) {
81	$path = \sprintf('%s/display/%s', $canonical, $view_mode);
82	$override_route = $this->buildSingleRoute($entity_type_id, $path, 'getBuilder', 'checkAccess');
83	$override_route->addDefaults(['view_mode_name' => $view_mode]);
84	$collection->add("entity.{$entity_type_id}.display_builder.{$view_mode}", $override_route);
85	}
86	}
87	}

OverridesRoutes->buildSingleRoute

104	private function buildSingleRoute(string $entity_type_id, string $path, string $controller, string $custom_access): Route {
105	$defaults = [
106	'_controller' => EntityViewOverridesController::class . '::' . $controller,
107	'_title_callback' => EntityViewOverridesController::class . '::title',
108	'entity_type_id' => $entity_type_id,
109	];
110	$requirements = [
111	'_entity_access' => "{$entity_type_id}.update",
112	'_custom_access' => EntityViewOverridesController::class . '::' . $custom_access,
113	];
114	$main_options = [
115	'parameters' => [
116	$entity_type_id => ['type' => 'entity:' . $entity_type_id],
117	],
118	];
119
120	return (new Route($path))
121	->setDefaults($defaults)
122	->setRequirements($requirements)
123	->setOptions($main_options);

OverridesRoutes->create

35	public static function create(ContainerInterface $container): static {
36	return new self(
37	$container->get('entity_type.manager'),

OverridesRoutes->getSubscribedEvents

45	$events = [];
46	// Run after \Drupal\field_ui\Routing\RouteSubscriber.
47	$events[RoutingEvents::ALTER] = ['onAlterRoutes', -110];
48
49	return $events;

OverridesRoutes->onAlterRoutes

58	public function onAlterRoutes(RouteBuildEvent $event): void {
59	$collection = $event->getRouteCollection();
60	$this->buildRoutes($collection);
61	}