diff --git a/core/modules/settings_tray/settings_tray.module b/core/modules/settings_tray/settings_tray.module index 48b08caaab..9a1c763efb 100644 --- a/core/modules/settings_tray/settings_tray.module +++ b/core/modules/settings_tray/settings_tray.module @@ -11,6 +11,7 @@ use Drupal\settings_tray\Block\BlockEntityOffCanvasForm; use Drupal\settings_tray\Form\SystemBrandingOffCanvasForm; use Drupal\settings_tray\Form\SystemMenuOffCanvasForm; +use Drupal\block\Entity\Block; /** * Implements hook_help(). @@ -196,3 +197,17 @@ function settings_tray_css_alter(&$css, AttachedAssetsInterface $assets) { $css[$path]['group'] = 200; } } + +/** + * Implements hook_contextual_links_alter(). + */ +function settings_tray_contextual_links_alter(array &$links, $group, array $route_parameters) { + if (isset($links['settings_tray.block_configure']['route_parameters']['block'])) { + /** @var \Drupal\block\BlockInterface $block */ + $block = Block::load($links['settings_tray.block_configure']['route_parameters']['block']); + $block_config = \Drupal::config($block->getEntityType()->getConfigPrefix() . '.' . $block->id()); + if ($block_config->hasOverrides()) { + $links['settings_tray.block_configure']['route_name'] = 'settings_tray.overridden_block_notice'; + } + } +} diff --git a/core/modules/settings_tray/settings_tray.routing.yml b/core/modules/settings_tray/settings_tray.routing.yml index 01109e4c79..8d74d6ac23 100644 --- a/core/modules/settings_tray/settings_tray.routing.yml +++ b/core/modules/settings_tray/settings_tray.routing.yml @@ -6,3 +6,10 @@ entity.block.off_canvas_form: requirements: _permission: 'administer blocks' _access_block_plugin_has_settings_tray_form: 'TRUE' +settings_tray.overridden_block_notice: + path: '/admin/settings-tray-overridden/{block}' + defaults: + _controller: '\Drupal\settings_tray\Controller\OverriddenBlockConfig::overrideNotice' + _title_callback: '\Drupal\settings_tray\Block\BlockEntityOffCanvasForm::title' + requirements: + _permission: 'administer blocks' diff --git a/core/modules/settings_tray/src/Controller/OverriddenBlockConfig.php b/core/modules/settings_tray/src/Controller/OverriddenBlockConfig.php new file mode 100644 index 0000000000..50efd38d7c --- /dev/null +++ b/core/modules/settings_tray/src/Controller/OverriddenBlockConfig.php @@ -0,0 +1,48 @@ + [ + '#type' => 'markup', + '#markup' => '

' . $this->t('This block cannot be edited in the Settings Tray form because it has configuration overrides in effect.') . '

', + ], + 'link' => [ + '#type' => 'link', + '#title' => $this->t('Edit block'), + '#url' => Url::fromRoute('entity.block.edit_form') + ->setRouteParameter('block', $block->id()) + ->setOption('query', ['destination' => \Drupal::request()->get('destination')]), + ], + ]; + + } + +} diff --git a/core/modules/settings_tray/tests/modules/settings_tray_override_test/settings_tray_override_test.info.yml b/core/modules/settings_tray/tests/modules/settings_tray_override_test/settings_tray_override_test.info.yml new file mode 100644 index 0000000000..89f9732feb --- /dev/null +++ b/core/modules/settings_tray/tests/modules/settings_tray_override_test/settings_tray_override_test.info.yml @@ -0,0 +1,7 @@ +name: 'Configuration override test for Settings Tray' +type: module +package: Testing +version: VERSION +core: 8.x +dependencies: + - settings_tray diff --git a/core/modules/settings_tray/tests/modules/settings_tray_override_test/settings_tray_override_test.services.yml b/core/modules/settings_tray/tests/modules/settings_tray_override_test/settings_tray_override_test.services.yml new file mode 100644 index 0000000000..b23035bde2 --- /dev/null +++ b/core/modules/settings_tray/tests/modules/settings_tray_override_test/settings_tray_override_test.services.yml @@ -0,0 +1,5 @@ +services: + settings_tray_override_test.overrider: + class: Drupal\settings_tray_override_test\ConfigOverrider + tags: + - { name: config.factory.override} diff --git a/core/modules/settings_tray/tests/modules/settings_tray_override_test/src/ConfigOverrider.php b/core/modules/settings_tray/tests/modules/settings_tray_override_test/src/ConfigOverrider.php new file mode 100644 index 0000000000..0184a9e533 --- /dev/null +++ b/core/modules/settings_tray/tests/modules/settings_tray_override_test/src/ConfigOverrider.php @@ -0,0 +1,48 @@ + ['settings' => ['label' => 'Now this will be the label.']]]; + } + return $overrides; + } + + /** + * {@inheritdoc} + */ + public function getCacheSuffix() { + return 'ConfigOverrider'; + } + + /** + * {@inheritdoc} + */ + public function createConfigObject($name, $collection = StorageInterface::DEFAULT_COLLECTION) { + return NULL; + } + + /** + * {@inheritdoc} + */ + public function getCacheableMetadata($name) { + return new CacheableMetadata(); + } + +} diff --git a/core/modules/settings_tray/tests/src/FunctionalJavascript/SettingsTrayBlockFormTest.php b/core/modules/settings_tray/tests/src/FunctionalJavascript/SettingsTrayBlockFormTest.php index fcfecde400..e1f76eb269 100644 --- a/core/modules/settings_tray/tests/src/FunctionalJavascript/SettingsTrayBlockFormTest.php +++ b/core/modules/settings_tray/tests/src/FunctionalJavascript/SettingsTrayBlockFormTest.php @@ -2,6 +2,7 @@ namespace Drupal\Tests\settings_tray\FunctionalJavascript; +use Drupal\block\BlockInterface; use Drupal\block\Entity\Block; use Drupal\block_content\Entity\BlockContent; use Drupal\block_content\Entity\BlockContentType; @@ -43,6 +44,7 @@ class SettingsTrayBlockFormTest extends OffCanvasTestBase { // cause test failures. 'settings_tray_test_css', 'settings_tray_test', + 'settings_tray_override_test', ]; /** @@ -75,7 +77,7 @@ public function testBlocks($theme, $block_plugin, $new_page_text, $element_selec $page = $this->getSession()->getPage(); $this->enableTheme($theme); $block = $this->placeBlock($block_plugin); - $block_selector = str_replace('_', '-', $this->getBlockSelector($block)); + $block_selector = $this->getBlockSelector($block); $block_id = $block->id(); $this->drupalGet('user'); @@ -267,8 +269,10 @@ protected function assertOffCanvasBlockFormIsValid() { * @param string $contextual_link_container * The element that contains the contextual links. If none provide the * $block_selector will be used. + * @param bool $has_confirm_form + * Determines if the block form should be confirmed. */ - protected function openBlockForm($block_selector, $contextual_link_container = '') { + protected function openBlockForm($block_selector, $contextual_link_container = '', $has_confirm_form = TRUE) { if (!$contextual_link_container) { $contextual_link_container = $block_selector; } @@ -283,7 +287,9 @@ protected function openBlockForm($block_selector, $contextual_link_container = ' $this->assertSession()->assertWaitOnAjaxRequest(); $this->click($block_selector); $this->waitForOffCanvasToOpen(); - $this->assertOffCanvasBlockFormIsValid(); + if ($has_confirm_form) { + $this->assertOffCanvasBlockFormIsValid(); + } } /** @@ -321,7 +327,7 @@ public function testQuickEditLinks() { $this->enableTheme($theme); $block = $this->placeBlock($block_plugin); - $block_selector = str_replace('_', '-', $this->getBlockSelector($block)); + $block_selector = $this->getBlockSelector($block); // Load the same page twice. foreach ([1, 2] as $page_load_times) { $this->drupalGet('node/' . $node->id()); @@ -531,7 +537,7 @@ public function testCustomBlockLinks() { * The CSS selector. */ public function getBlockSelector(Block $block) { - return '#block-' . $block->id(); + return '#block-' . str_replace('_', '-', $block->id()); } /** @@ -577,4 +583,36 @@ protected function getTestThemes() { }); } + /** + * Tests that blocks with configuration overrides are disabled. + */ + public function testOverriddenDisabled() { + $web_assert = $this->assertSession(); + $overridden_text = 'This block cannot be edited in the Settings Tray form because it has configuration overrides in effect.'; + // Test a overridden block does not show the form in the off-canvas dialog. + // @see \Drupal\settings_tray_override_test\ConfigOverrider + $overridden_block = $this->placeBlock('system_powered_by_block', [ + 'id' => 'overridden_block', + 'label_display' => 1, + 'label' => 'This will be overridden.', + ]); + $this->drupalGet('user'); + // Confirm the label is actually overridden. + $web_assert->elementContains('css', $this->getBlockSelector($overridden_block), 'Now this will be the label.'); + $this->enableEditMode(); + $this->openBlockForm($this->getBlockSelector($overridden_block), '', FALSE); + $web_assert->elementContains('css', self::OFF_CANVAS_CSS_SELECTOR, $overridden_text); + + // Test a non-overridden block does show the form in the off-canvas dialog. + $block = $this->placeBlock('system_powered_by_block', [ + 'label_display' => 1, + 'label' => 'Labely label', + ]); + $this->drupalGet('user'); + // Confirm the label is not overridden. + $web_assert->elementContains('css', $this->getBlockSelector($block), 'Labely label'); + $this->openBlockForm($this->getBlockSelector($block)); + $web_assert->elementNotContains('css', self::OFF_CANVAS_CSS_SELECTOR, $overridden_text); + } + } diff --git a/core/modules/system/tests/src/FunctionalJavascript/OffCanvasTestBase.php b/core/modules/system/tests/src/FunctionalJavascript/OffCanvasTestBase.php index d3f446cf6a..86cca2c680 100644 --- a/core/modules/system/tests/src/FunctionalJavascript/OffCanvasTestBase.php +++ b/core/modules/system/tests/src/FunctionalJavascript/OffCanvasTestBase.php @@ -9,6 +9,11 @@ */ abstract class OffCanvasTestBase extends JavascriptTestBase { + /** + * CSS selector for the off-canvas dialog. + */ + const OFF_CANVAS_CSS_SELECTOR = '.ui-dialog[aria-describedby="drupal-off-canvas"]'; + /** * {@inheritdoc} */ @@ -83,7 +88,7 @@ protected function waitForOffCanvasToClose() { * @return \Behat\Mink\Element\NodeElement|null */ protected function getOffCanvasDialog() { - $off_canvas_dialog = $this->getSession()->getPage()->find('css', '.ui-dialog[aria-describedby="drupal-off-canvas"]'); + $off_canvas_dialog = $this->getSession()->getPage()->find('css', self::OFF_CANVAS_CSS_SELECTOR); $this->assertEquals(FALSE, empty($off_canvas_dialog), 'The off-canvas dialog was found.'); return $off_canvas_dialog; }