1	<?php
2
3	declare(strict_types=1);
4
5	namespace Drupal\display_builder_page_layout\EventSubscriber;
6
7	use Drupal\Core\Entity\EntityTypeManagerInterface;
8	use Drupal\Core\Render\PageDisplayVariantSelectionEvent;
9	use Drupal\Core\Render\RenderEvents;
10	use Symfony\Component\EventDispatcher\EventSubscriberInterface;
11
12	/**
13	* Drupal should return a display builder page for any non admin route.
14	*
15	* @code
16	* route.name:
17	*  ...
18	*  options:
19	*    _admin_route: false
20	*    _display_builder_route: true
21	*
22	* @endcode
23	*/
24	class PageVariantSubscriber implements EventSubscriberInterface {
25
26	public function __construct(
27	private EntityTypeManagerInterface $entityTypeManager,
28	) {}
29
30	/**
31	* {@inheritdoc}
32	*/
33	public static function getSubscribedEvents(): array {
34	return [
35	RenderEvents::SELECT_PAGE_DISPLAY_VARIANT => [
36	['onSelectPageDisplayVariant', -100],
37	],
38	];
39	}
40
41	/**
42	* Selects the page display variant.
43	*
44	* @param \Drupal\Core\Render\PageDisplayVariantSelectionEvent $event
45	*   The event to process.
46	*/
47	public function onSelectPageDisplayVariant(PageDisplayVariantSelectionEvent $event): void {
48	$route = $event->getRouteMatch()->getRouteObject();
49	$options = $route->getOptions();
50
51	// In admin pages, we want the page.html.twig from the admin theme.
52	// For now we don't build pages for Admin routes, but this will be possible
53	// in the future.
54	if ($options['_admin_route'] ?? FALSE) {
55	return;
56	}
57
58	// When we use Display Builder to build the full page, we don't want to have
59	// neither the theme's page.html.twig nor the page managed by Display
60	// Builder. We want a simple blank page.
61	// Example: entity.page_layout.display_builder.
62	if ($options['_display_builder_route'] ?? FALSE) {
63	$event->setPluginId('simple_page');
64
65	return;
66	}
67
68	// Fallback to Block Layout if there is no suitable Page Layout entities.
69	/** @var \Drupal\display_builder_page_layout\AccessControlHandler $access_control */
70	$access_control = $this->entityTypeManager->getAccessControlHandler('page_layout');
71	$page_layout = $access_control->loadCurrentPageLayout();
72
73	// In DisplayBuilderPageVariant we add PageLayout::getCacheTags() to the
74	// page renderable but it works only for the pages already managed by
75	// Display Builder.
76	// So let's add a custom tag for the others.
77	/** @var \Drupal\Core\Config\Entity\ConfigEntityTypeInterface $entity_type */
78	$entity_type = $this->entityTypeManager->getDefinition('page_layout');
79	$event->addCacheTags([$entity_type->getConfigPrefix()]);
80
81	if (!$page_layout) {
82	return;
83	}
84
85	// Every other pages must be managed by Display Builder.
86	$event->setPluginId('display_builder');
87	}
88
89	}

---

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.

PageVariantSubscriber->__construct

26	public function __construct(
27	private EntityTypeManagerInterface $entityTypeManager,
28	) {}

PageVariantSubscriber->getSubscribedEvents

35	RenderEvents::SELECT_PAGE_DISPLAY_VARIANT => [
36	['onSelectPageDisplayVariant', -100],

PageVariantSubscriber->onSelectPageDisplayVariant

47	public function onSelectPageDisplayVariant(PageDisplayVariantSelectionEvent $event): void {
48	$route = $event->getRouteMatch()->getRouteObject();
49	$options = $route->getOptions();
50
51	// In admin pages, we want the page.html.twig from the admin theme.
52	// For now we don't build pages for Admin routes, but this will be possible
53	// in the future.
54	if ($options['_admin_route'] ?? FALSE) {
55	return;

47	public function onSelectPageDisplayVariant(PageDisplayVariantSelectionEvent $event): void {
48	$route = $event->getRouteMatch()->getRouteObject();
49	$options = $route->getOptions();
50
51	// In admin pages, we want the page.html.twig from the admin theme.
52	// For now we don't build pages for Admin routes, but this will be possible
53	// in the future.
54	if ($options['_admin_route'] ?? FALSE) {
62	if ($options['_display_builder_route'] ?? FALSE) {
63	$event->setPluginId('simple_page');
64
65	return;

47	public function onSelectPageDisplayVariant(PageDisplayVariantSelectionEvent $event): void {
48	$route = $event->getRouteMatch()->getRouteObject();
49	$options = $route->getOptions();
50
51	// In admin pages, we want the page.html.twig from the admin theme.
52	// For now we don't build pages for Admin routes, but this will be possible
53	// in the future.
54	if ($options['_admin_route'] ?? FALSE) {
62	if ($options['_display_builder_route'] ?? FALSE) {
70	$access_control = $this->entityTypeManager->getAccessControlHandler('page_layout');
71	$page_layout = $access_control->loadCurrentPageLayout();
72
73	// In DisplayBuilderPageVariant we add PageLayout::getCacheTags() to the
74	// page renderable but it works only for the pages already managed by
75	// Display Builder.
76	// So let's add a custom tag for the others.
77	/** @var \Drupal\Core\Config\Entity\ConfigEntityTypeInterface $entity_type */
78	$entity_type = $this->entityTypeManager->getDefinition('page_layout');
79	$event->addCacheTags([$entity_type->getConfigPrefix()]);
80
81	if (!$page_layout) {
82	return;

47	public function onSelectPageDisplayVariant(PageDisplayVariantSelectionEvent $event): void {
48	$route = $event->getRouteMatch()->getRouteObject();
49	$options = $route->getOptions();
50
51	// In admin pages, we want the page.html.twig from the admin theme.
52	// For now we don't build pages for Admin routes, but this will be possible
53	// in the future.
54	if ($options['_admin_route'] ?? FALSE) {
62	if ($options['_display_builder_route'] ?? FALSE) {
70	$access_control = $this->entityTypeManager->getAccessControlHandler('page_layout');
71	$page_layout = $access_control->loadCurrentPageLayout();
72
73	// In DisplayBuilderPageVariant we add PageLayout::getCacheTags() to the
74	// page renderable but it works only for the pages already managed by
75	// Display Builder.
76	// So let's add a custom tag for the others.
77	/** @var \Drupal\Core\Config\Entity\ConfigEntityTypeInterface $entity_type */
78	$entity_type = $this->entityTypeManager->getDefinition('page_layout');
79	$event->addCacheTags([$entity_type->getConfigPrefix()]);
80
81	if (!$page_layout) {
86	$event->setPluginId('display_builder');
87	}