feat: #3561564 Support the same block being used for page title & main content (8ada62c8) · Commits · project / drupal

core/modules/block/src/Plugin/DisplayVariant/BlockPageVariant.php

+2 −2

Changes for core/modules/block/src/Plugin/DisplayVariant/BlockPageVariant.php: 2 added lines, 2 removed lines.
Original line number	Diff line number	Diff line
		@@ -143,10 +143,10 @@ public function build() {
		$block_plugin->setMainContent($this->mainContent);
		$main_content_block_displayed = TRUE;
		}
		elseif ($block_plugin instanceof TitleBlockPluginInterface) {
		if ($block_plugin instanceof TitleBlockPluginInterface) {
		$block_plugin->setTitle($this->title);
		}
		elseif ($block_plugin instanceof MessagesBlockPluginInterface) {
		if ($block_plugin instanceof MessagesBlockPluginInterface) {
		$messages_block_displayed = TRUE;
		}
		$build[$region][$key] = $this->blockViewBuilder->view($block);

core/modules/block/tests/modules/block_test/src/Plugin/Block/TestPageTitleMainContentAndMessagesBlock.php

0 → 100644

+108 −0

Changes for core/modules/block/tests/modules/block_test/src/Plugin/Block/TestPageTitleMainContentAndMessagesBlock.php: 108 added lines, 0 removed lines.
Original line number	Diff line number	Diff line
		<?php

		declare(strict_types=1);

		namespace Drupal\block_test\Plugin\Block;

		use Drupal\Core\Block\Attribute\Block;
		use Drupal\Core\Block\BlockBase;
		use Drupal\Core\Block\MainContentBlockPluginInterface;
		use Drupal\Core\Block\MessagesBlockPluginInterface;
		use Drupal\Core\Block\TitleBlockPluginInterface;
		use Drupal\Core\StringTranslation\TranslatableMarkup;

		/**
		* Provides a block which includes page title, main content & messages together.
		*/
		#[Block(
		id: "test_title_content_message_block",
		admin_label: new TranslatableMarkup("Test Page Title, Content, and Message Block"),
		)]
		class TestPageTitleMainContentAndMessagesBlock extends BlockBase implements MainContentBlockPluginInterface, TitleBlockPluginInterface, MessagesBlockPluginInterface {

		/**
		* The page title: a string (plain title) or a render array (formatted title).
		*
		* @var string\|array
		*/
		protected $title = '';

		/**
		* The render array representing the main page content.
		*
		* @var array
		*/
		protected $mainContent;

		/**
		* Whether setMainContent was called.
		*
		* @var bool
		*/
		protected $isMainContentPlaced = FALSE;

		/**
		* Whether setTitle was called.
		*
		* @var bool
		*/
		protected $isPageTitlePlaced = FALSE;

		/**
		* {@inheritdoc}
		*/
		public function setMainContent(array $main_content): void {
		$this->mainContent = $main_content;
		$this->isMainContentPlaced = TRUE;
		}

		/**
		* {@inheritdoc}
		*/
		public function setTitle($title): static {
		$this->title = $title;
		$this->isPageTitlePlaced = TRUE;
		return $this;
		}

		/**
		* {@inheritdoc}
		*/
		public function build(): array {
		$build = [];
		// Print a message to later verify that messages are rendered in the block.
		$this->messenger()->addStatus('This is a status message.');

		if ($this->isPageTitlePlaced === TRUE) {
		$build['page_title'] = [
		'#type' => 'page_title',
		'#title' => $this->title,
		];
		// Display text which confirms title was displayed by this block.
		// Content of text is used in corresponding test.
		$build['page_title_confirmation'] = [
		'#markup' => $this->t('Page title has been placed in the block.'),
		];
		}

		if ($this->isMainContentPlaced === TRUE) {
		$build['main_content'] = $this->mainContent;
		// Display text which confirms main content was displayed by this block.
		// Content of text is used in corresponding test.
		$build['main_content_confirmation'] = [
		'#markup' => $this->t('Main content has been placed in the block.'),
		];
		}

		$build['content']['messages'] = [
		'#prefix' => '<div id="test-block-messages-wrapper">',
		'#weight' => -1000,
		'#type' => 'status_messages',
		'#include_fallback' => TRUE,
		'#suffix' => '</div>',
		];

		return $build;
		}

		}

core/modules/block/tests/src/Functional/BlockTest.php

+19 −0

Changes for core/modules/block/tests/src/Functional/BlockTest.php: 19 added lines, 0 removed lines.
Original line number	Diff line number	Diff line
		@@ -643,4 +643,23 @@ public function testBlockTitle(): void {
		$this->assertEquals("$title (disabled)", $elements[0]->getText());
		}

		/**
		* Tests a combined page title, content, and messages block.
		*/
		public function testTitleContentMessagesSingleBlock(): void {
		// Place block which implements MainContentBlockPluginInterface,
		// TitleBlockPluginInterface, and MessagesBlockPluginInterface.
		$this->drupalPlaceBlock('test_title_content_message_block');
		$this->drupalGet('');

		// Ensure the block's setTitle function was called.
		$this->assertSession()->pageTextContains('Page title has been placed in the block.');

		// Ensure the block's setMainContent function was called.
		$this->assertSession()->pageTextContains('Main content has been placed in the block.');

		// Ensure the status message is shown.
		$this->assertSession()->statusMessageContains('This is a status message.', 'status');
		}

		}