Issue #3143635 by b_sharpe, tim.plunkett, alexpott: Change Layout Preparation... (e77ca8b3) · Commits · project / drupal

core/modules/layout_builder/layout_builder.services.yml

+5 −0

Original line number	Diff line number	Diff line
		@@ -51,3 +51,8 @@ services:
		class: Drupal\layout_builder\Controller\LayoutBuilderHtmlEntityFormController
		public: false
		arguments: ['@layout_builder.controller.entity_form.inner']
		layout_builder.element.prepare_layout:
		class: Drupal\layout_builder\EventSubscriber\PrepareLayout
		arguments: ['@layout_builder.tempstore_repository', '@messenger']
		tags:
		- { name: event_subscriber }

core/modules/layout_builder/src/Element/LayoutBuilder.php

+25 −35

Original line number	Diff line number	Diff line
		@@ -3,18 +3,18 @@
		namespace Drupal\layout_builder\Element;

		use Drupal\Core\Ajax\AjaxHelperTrait;
		use Drupal\Core\Messenger\MessengerInterface;
		use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
		use Drupal\Core\Plugin\PluginFormInterface;
		use Drupal\Core\Render\Element;
		use Drupal\Core\Render\Element\RenderElement;
		use Drupal\Core\Url;
		use Drupal\layout_builder\Context\LayoutBuilderContextTrait;
		use Drupal\layout_builder\Event\PrepareLayoutEvent;
		use Drupal\layout_builder\LayoutBuilderEvents;
		use Drupal\layout_builder\LayoutBuilderHighlightTrait;
		use Drupal\layout_builder\LayoutTempstoreRepositoryInterface;
		use Drupal\layout_builder\OverridesSectionStorageInterface;
		use Drupal\layout_builder\SectionStorageInterface;
		use Symfony\Component\DependencyInjection\ContainerInterface;
		use Symfony\Component\EventDispatcher\EventDispatcherInterface;

		/**
		* Defines a render element for building the Layout Builder UI.
		@@ -31,18 +31,11 @@ class LayoutBuilder extends RenderElement implements ContainerFactoryPluginInter
		use LayoutBuilderHighlightTrait;

		/**
		* The layout tempstore repository.
		* The event dispatcher.
		*
		* @var \Drupal\layout_builder\LayoutTempstoreRepositoryInterface
		* @var \Symfony\Component\EventDispatcher\EventDispatcherInterface
		*/
		protected $layoutTempstoreRepository;

		/**
		* The messenger service.
		*
		* @var \Drupal\Core\Messenger\MessengerInterface
		*/
		protected $messenger;
		protected $eventDispatcher;

		/**
		* Constructs a new LayoutBuilder.
		@@ -53,15 +46,24 @@ class LayoutBuilder extends RenderElement implements ContainerFactoryPluginInter
		* The plugin ID for the plugin instance.
		* @param mixed $plugin_definition
		* The plugin implementation definition.
		* @param \Drupal\layout_builder\LayoutTempstoreRepositoryInterface $layout_tempstore_repository
		* The layout tempstore repository.
		* @param \Drupal\Core\Messenger\MessengerInterface $messenger
		* The messenger service.
		* @param \Symfony\Component\EventDispatcher\EventDispatcherInterface $event_dispatcher
		* The event dispatcher service.
		* @param \Drupal\Core\Messenger\MessengerInterface\|null $messenger
		* The messenger service. This is no longer used and will be removed in
		* drupal:10.0.0.
		*/
		public function __construct(array $configuration, $plugin_id, $plugin_definition, LayoutTempstoreRepositoryInterface $layout_tempstore_repository, MessengerInterface $messenger) {
		public function __construct(array $configuration, $plugin_id, $plugin_definition, $event_dispatcher, $messenger = NULL) {
		parent::__construct($configuration, $plugin_id, $plugin_definition);
		$this->layoutTempstoreRepository = $layout_tempstore_repository;
		$this->messenger = $messenger;

		if (!($event_dispatcher instanceof EventDispatcherInterface)) {
		@trigger_error('The event_dispatcher service should be passed to LayoutBuilder::__construct() instead of the layout_builder.tempstore_repository service since 9.1.0. This will be required in Drupal 10.0.0. See https://www.drupal.org/node/3152690', E_USER_DEPRECATED);
		$event_dispatcher = \Drupal::service('event_dispatcher');
		}
		$this->eventDispatcher = $event_dispatcher;

		if ($messenger) {
		@trigger_error('Calling LayoutBuilder::__construct() with the $messenger argument is deprecated in drupal:9.1.0 and will be removed in drupal:10.0.0. See https://www.drupal.org/node/3152690', E_USER_DEPRECATED);
		}
		}

		/**
		@@ -72,8 +74,7 @@ public static function create(ContainerInterface $container, array $configuratio
		$configuration,
		$plugin_id,
		$plugin_definition,
		$container->get('layout_builder.tempstore_repository'),
		$container->get('messenger')
		$container->get('event_dispatcher')
		);
		}

		@@ -145,19 +146,8 @@ protected function layout(SectionStorageInterface $section_storage) {
		* The section storage.
		*/
		protected function prepareLayout(SectionStorageInterface $section_storage) {
		// If the layout has pending changes, add a warning.
		if ($this->layoutTempstoreRepository->has($section_storage)) {
		$this->messenger->addWarning($this->t('You have unsaved changes.'));
		}
		// If the layout is an override that has not yet been overridden, copy the
		// sections from the corresponding default.
		elseif ($section_storage instanceof OverridesSectionStorageInterface && !$section_storage->isOverridden()) {
		$sections = $section_storage->getDefaultSectionStorage()->getSections();
		foreach ($sections as $section) {
		$section_storage->appendSection($section);
		}
		$this->layoutTempstoreRepository->set($section_storage);
		}
		$event = new PrepareLayoutEvent($section_storage);
		$this->eventDispatcher->dispatch($event, LayoutBuilderEvents::PREPARE_LAYOUT);
		}

		/**

core/modules/layout_builder/src/Event/PrepareLayoutEvent.php

0 → 100644

+45 −0

Original line number	Diff line number	Diff line
		<?php

		namespace Drupal\layout_builder\Event;

		use Drupal\layout_builder\SectionStorageInterface;
		use Drupal\Component\EventDispatcher\Event;

		/**
		* Event fired in #pre_render of \Drupal\layout_builder\Element\LayoutBuilder.
		*
		* Subscribers to this event can prepare section storage before rendering.
		*
		* @see \Drupal\layout_builder\LayoutBuilderEvents::PREPARE_LAYOUT
		* @see \Drupal\layout_builder\Element\LayoutBuilder::prepareLayout()
		*/
		class PrepareLayoutEvent extends Event {

		/**
		* The section storage plugin.
		*
		* @var \Drupal\layout_builder\SectionStorageInterface
		*/
		protected $sectionStorage;

		/**
		* Constructs a new PrepareLayoutEvent.
		*
		* @param \Drupal\layout_builder\SectionStorageInterface $section_storage
		* The section storage preparing the Layout.
		*/
		public function __construct(SectionStorageInterface $section_storage) {
		$this->sectionStorage = $section_storage;
		}

		/**
		* Gets the section storage.
		*
		* @return \Drupal\layout_builder\SectionStorageInterface
		* The section storage.
		*/
		public function getSectionStorage(): SectionStorageInterface {
		return $this->sectionStorage;
		}

		}

core/modules/layout_builder/src/EventSubscriber/PrepareLayout.php

0 → 100644

+83 −0

Original line number	Diff line number	Diff line
		<?php

		namespace Drupal\layout_builder\EventSubscriber;

		use Drupal\Core\Messenger\MessengerInterface;
		use Drupal\Core\StringTranslation\StringTranslationTrait;
		use Drupal\layout_builder\Event\PrepareLayoutEvent;
		use Drupal\layout_builder\LayoutBuilderEvents;
		use Drupal\layout_builder\LayoutTempstoreRepositoryInterface;
		use Drupal\layout_builder\OverridesSectionStorageInterface;
		use Symfony\Component\EventDispatcher\EventSubscriberInterface;

		/**
		* An event subscriber to prepare section storage via the
		* \Drupal\layout_builder\Event\PrepareLayoutEvent.
		*
		* @see \Drupal\layout_builder\Event\PrepareLayoutEvent
		* @see \Drupal\layout_builder\Element\LayoutBuilder::prepareLayout()
		*/
		class PrepareLayout implements EventSubscriberInterface {

		use StringTranslationTrait;

		/**
		* The layout tempstore repository.
		*
		* @var \Drupal\layout_builder\LayoutTempstoreRepositoryInterface
		*/
		protected $layoutTempstoreRepository;

		/**
		* The messenger service.
		*
		* @var \Drupal\Core\Messenger\MessengerInterface
		*/
		protected $messenger;

		/**
		* Constructs a new PrepareLayout.
		*
		* @param \Drupal\layout_builder\LayoutTempstoreRepositoryInterface $layout_tempstore_repository
		* The tempstore repository.
		* @param \Drupal\Core\Messenger\MessengerInterface $messenger
		* The messenger service.
		*/
		public function __construct(LayoutTempstoreRepositoryInterface $layout_tempstore_repository, MessengerInterface $messenger) {
		$this->layoutTempstoreRepository = $layout_tempstore_repository;
		$this->messenger = $messenger;
		}

		/**
		* {@inheritdoc}
		*/
		public static function getSubscribedEvents() {
		$events[LayoutBuilderEvents::PREPARE_LAYOUT][] = ['onPrepareLayout', 10];
		return $events;
		}

		/**
		* Prepares a layout for use in the UI.
		*
		* @param \Drupal\layout_builder\Event\PrepareLayoutEvent $event
		* The prepare layout event.
		*/
		public function onPrepareLayout(PrepareLayoutEvent $event) {
		$section_storage = $event->getSectionStorage();

		// If the layout has pending changes, add a warning.
		if ($this->layoutTempstoreRepository->has($section_storage)) {
		$this->messenger->addWarning($this->t('You have unsaved changes.'));
		}
		// If the layout is an override that has not yet been overridden, copy the
		// sections from the corresponding default.
		elseif ($section_storage instanceof OverridesSectionStorageInterface && !$section_storage->isOverridden()) {
		$sections = $section_storage->getDefaultSectionStorage()->getSections();
		foreach ($sections as $section) {
		$section_storage->appendSection($section);
		}
		$this->layoutTempstoreRepository->set($section_storage);
		}
		}

		}

core/modules/layout_builder/src/LayoutBuilderEvents.php

+13 −0

Original line number	Diff line number	Diff line
		@@ -26,4 +26,17 @@ final class LayoutBuilderEvents {
		*/
		const SECTION_COMPONENT_BUILD_RENDER_ARRAY = 'section_component.build.render_array';

		/**
		* Name of the event fired in when preparing a layout builder element.
		*
		* This event allows modules to collaborate on creating the sections used in
		* \Drupal\layout_builder\Element\LayoutBuilder during #pre_render.
		*
		* @see \Drupal\layout_builder\Event\PrepareLayoutEvent
		* @see \Drupal\layout_builder\Element\LayoutBuilder
		*
		* @var string
		*/
		const PREPARE_LAYOUT = 'prepare_layout';

		}