' . t('The Field Layout module allows you to arrange fields into regions on forms and displays of entities such as nodes and users.') . '
'; + $output .= '' . t('The Field Layout module is obsolete and its functionality is now part of the Field UI module.') . '
'; $output .= '' . t('For more information, see the online documentation for the Field Layout module.', [':field-layout-documentation' => 'https://www.drupal.org/documentation/modules/field_layout']) . '
'; return $output; } } - -/** - * Implements hook_entity_type_alter(). - */ -function field_layout_entity_type_alter(array &$entity_types) { - /** @var $entity_types \Drupal\Core\Entity\EntityTypeInterface[] */ - $entity_types['entity_view_display']->setClass(FieldLayoutEntityViewDisplay::class); - $entity_types['entity_form_display']->setClass(FieldLayoutEntityFormDisplay::class); - - // The form classes are only needed when Field UI is installed. - if (\Drupal::moduleHandler()->moduleExists('field_ui')) { - $entity_types['entity_view_display']->setFormClass('edit', FieldLayoutEntityViewDisplayEditForm::class); - $entity_types['entity_form_display']->setFormClass('edit', FieldLayoutEntityFormDisplayEditForm::class); - } -} - -/** - * Implements hook_entity_view_alter(). - */ -function field_layout_entity_view_alter(array &$build, EntityInterface $entity, EntityViewDisplayInterface $display) { - if ($display instanceof EntityDisplayWithLayoutInterface) { - \Drupal::classResolver(FieldLayoutBuilder::class)->buildView($build, $display); - } -} - -/** - * Implements hook_form_alter(). - */ -function field_layout_form_alter(&$form, FormStateInterface $form_state, $form_id) { - $form_object = $form_state->getFormObject(); - if ($form_object instanceof ContentEntityFormInterface && $display = $form_object->getFormDisplay($form_state)) { - if ($display instanceof EntityDisplayWithLayoutInterface) { - \Drupal::classResolver(FieldLayoutBuilder::class)->buildForm($form, $display); - } - } -} diff --git a/core/modules/field_layout/src/Entity/FieldLayoutEntityDisplayTrait.php b/core/modules/field_layout/src/Entity/FieldLayoutEntityDisplayTrait.php deleted file mode 100644 index 652b72b49b..0000000000 --- a/core/modules/field_layout/src/Entity/FieldLayoutEntityDisplayTrait.php +++ /dev/null @@ -1,161 +0,0 @@ -getDefinition($layout_id); - } - - /** - * Implements \Drupal\field_layout\Display\EntityDisplayWithLayoutInterface::getLayoutId(). - */ - public function getLayoutId() { - return $this->getThirdPartySetting('field_layout', 'id'); - } - - /** - * Implements \Drupal\field_layout\Display\EntityDisplayWithLayoutInterface::getLayoutSettings(). - */ - public function getLayoutSettings() { - return $this->getThirdPartySetting('field_layout', 'settings', []); - } - - /** - * Implements \Drupal\field_layout\Display\EntityDisplayWithLayoutInterface::setLayoutId(). - */ - public function setLayoutId($layout_id, array $layout_settings = []) { - if ($this->getLayoutId() !== $layout_id) { - // @todo Devise a mechanism for mapping old regions to new ones in - // https://www.drupal.org/node/2796877. - $layout_definition = $this->getLayoutDefinition($layout_id); - $new_region = $layout_definition->getDefaultRegion(); - $layout_regions = $layout_definition->getRegions(); - foreach ($this->getComponents() as $name => $component) { - if (isset($component['region']) && !isset($layout_regions[$component['region']])) { - $component['region'] = $new_region; - $this->setComponent($name, $component); - } - } - } - $this->setThirdPartySetting('field_layout', 'id', $layout_id); - // Instantiate the plugin and consult it for the updated plugin - // configuration. Once layouts are no longer stored as third party settings, - // this will be handled by the code in - // \Drupal\Core\Config\Entity\ConfigEntityBase::set() that handles - // \Drupal\Core\Entity\EntityWithPluginCollectionInterface. - $layout_settings = $this->doGetLayout($layout_id, $layout_settings)->getConfiguration(); - $this->setThirdPartySetting('field_layout', 'settings', $layout_settings); - return $this; - } - - /** - * Implements \Drupal\field_layout\Display\EntityDisplayWithLayoutInterface::setLayout(). - */ - public function setLayout(LayoutInterface $layout) { - $this->setLayoutId($layout->getPluginId(), $layout->getConfiguration()); - return $this; - } - - /** - * Implements \Drupal\field_layout\Display\EntityDisplayWithLayoutInterface::getLayout(). - */ - public function getLayout() { - return $this->doGetLayout($this->getLayoutId(), $this->getLayoutSettings()); - } - - /** - * Gets the layout plugin. - * - * @param string $layout_id - * A layout plugin ID. - * @param array $layout_settings - * An array of settings. - * - * @return \Drupal\Core\Layout\LayoutInterface - * The layout plugin. - */ - protected function doGetLayout($layout_id, array $layout_settings) { - return \Drupal::service('plugin.manager.core.layout')->createInstance($layout_id, $layout_settings); - } - - /** - * Overrides \Drupal\Core\Entity\EntityDisplayBase::init(). - */ - protected function init() { - $this->ensureLayout(); - parent::init(); - } - - /** - * Overrides \Drupal\Core\Entity\EntityDisplayBase::preSave(). - */ - public function preSave(EntityStorageInterface $storage) { - parent::preSave($storage); - - // Ensure the plugin configuration is updated. Once layouts are no longer - // stored as third party settings, this will be handled by the code in - // \Drupal\Core\Config\Entity\ConfigEntityBase::preSave() that handles - // \Drupal\Core\Entity\EntityWithPluginCollectionInterface. - if ($this->getLayoutId()) { - $this->setLayout($this->getLayout()); - } - } - - /** - * {@inheritdoc} - */ - public function ensureLayout($default_layout_id = 'layout_onecol') { - if (!$this->getLayoutId()) { - $this->setLayoutId($default_layout_id); - } - - return $this; - } - - /** - * Overrides \Drupal\Core\Entity\EntityDisplayBase::calculateDependencies(). - * - * Ensure the plugin dependencies are included. Once layouts are no longer - * stored as third party settings, this will be handled by the code in - * \Drupal\Core\Config\Entity\ConfigEntityBase::calculateDependencies() that - * handles \Drupal\Core\Entity\EntityWithPluginCollectionInterface. - */ - public function calculateDependencies() { - parent::calculateDependencies(); - - // This can be called during uninstallation, so check for a valid ID first. - if ($this->getLayoutId()) { - $this->calculatePluginDependencies($this->getLayout()); - } - return $this; - } - - /** - * Implements \Drupal\field_layout\Display\EntityDisplayWithLayoutInterface::getDefaultRegion(). - */ - public function getDefaultRegion() { - return $this->getLayoutDefinition($this->getLayoutId())->getDefaultRegion(); - } - -} diff --git a/core/modules/field_layout/src/Entity/FieldLayoutEntityFormDisplay.php b/core/modules/field_layout/src/Entity/FieldLayoutEntityFormDisplay.php deleted file mode 100644 index 275d4b04d3..0000000000 --- a/core/modules/field_layout/src/Entity/FieldLayoutEntityFormDisplay.php +++ /dev/null @@ -1,15 +0,0 @@ -layoutPluginManager = $layout_plugin_manager; - $this->entityFieldManager = $entity_field_manager; - } - - /** - * {@inheritdoc} - */ - public static function create(ContainerInterface $container) { - return new static( - $container->get('plugin.manager.core.layout'), - $container->get('entity_field.manager') - ); - } - - /** - * Applies the layout to an entity build. - * - * @param array $build - * A renderable array representing the entity content or form. - * @param \Drupal\field_layout\Display\EntityDisplayWithLayoutInterface $display - * The entity display holding the display options configured for the entity - * components. - */ - public function buildView(array &$build, EntityDisplayWithLayoutInterface $display) { - $layout_definition = $this->layoutPluginManager->getDefinition($display->getLayoutId(), FALSE); - if ($layout_definition && $fields = $this->getFields($build, $display, 'view')) { - // Add the regions to the $build in the correct order. - $regions = array_fill_keys($layout_definition->getRegionNames(), []); - - foreach ($fields as $name => $field) { - // If the region is controlled by the layout, move the field from the - // top-level of $build into a region-specific section. Custom regions - // could be set by other code at run-time; these should be ignored. - // @todo Ideally the array structure would remain unchanged, see - // https://www.drupal.org/node/2846393. - if (isset($regions[$field['region']])) { - $regions[$field['region']][$name] = $build[$name]; - unset($build[$name]); - } - } - // Ensure this will not conflict with any existing array elements by - // prefixing with an underscore. - $build['_field_layout'] = $display->getLayout()->build($regions); - } - } - - /** - * Applies the layout to an entity form. - * - * @param array $build - * A renderable array representing the entity content or form. - * @param \Drupal\field_layout\Display\EntityDisplayWithLayoutInterface $display - * The entity display holding the display options configured for the entity - * components. - */ - public function buildForm(array &$build, EntityDisplayWithLayoutInterface $display) { - $layout_definition = $this->layoutPluginManager->getDefinition($display->getLayoutId(), FALSE); - if ($layout_definition && $fields = $this->getFields($build, $display, 'form')) { - $fill = []; - $fill['#process'][] = '\Drupal\Core\Render\Element\RenderElement::processGroup'; - $fill['#pre_render'][] = '\Drupal\Core\Render\Element\RenderElement::preRenderGroup'; - // Add the regions to the $build in the correct order. - $regions = array_fill_keys($layout_definition->getRegionNames(), $fill); - - foreach ($fields as $name => $field) { - // As this is a form, #group can be used to relocate the fields. This - // avoids breaking hook_form_alter() implementations by not actually - // moving the field in the form structure. If a #group is already set, - // do not overwrite it. - if (isset($regions[$field['region']]) && !isset($build[$name]['#group'])) { - $build[$name]['#group'] = $field['region']; - } - } - // Ensure this will not conflict with any existing array elements by - // prefixing with an underscore. - $build['_field_layout'] = $display->getLayout()->build($regions); - } - } - - /** - * Gets the fields that need to be processed. - * - * @param array $build - * A renderable array representing the entity content or form. - * @param \Drupal\field_layout\Display\EntityDisplayWithLayoutInterface $display - * The entity display holding the display options configured for the entity - * components. - * @param string $display_context - * The display context, either 'form' or 'view'. - * - * @return array - * An array of configurable fields present in the build. - */ - protected function getFields(array $build, EntityDisplayWithLayoutInterface $display, $display_context) { - $components = $display->getComponents(); - - // Ignore any extra fields from the list of field definitions. Field - // definitions can have a non-configurable display, but all extra fields are - // always displayed. - $field_definitions = array_diff_key( - $this->entityFieldManager->getFieldDefinitions($display->getTargetEntityTypeId(), $display->getTargetBundle()), - $this->entityFieldManager->getExtraFields($display->getTargetEntityTypeId(), $display->getTargetBundle()) - ); - - $fields_to_exclude = array_filter($field_definitions, function (FieldDefinitionInterface $field_definition) use ($display_context) { - // Remove fields with a non-configurable display. - return !$field_definition->isDisplayConfigurable($display_context); - }); - $components = array_diff_key($components, $fields_to_exclude); - - // Only include fields present in the build. - $components = array_intersect_key($components, $build); - - return $components; - } - -} diff --git a/core/modules/field_layout/src/Form/FieldLayoutEntityDisplayFormTrait.php b/core/modules/field_layout/src/Form/FieldLayoutEntityDisplayFormTrait.php deleted file mode 100644 index 170bcd093a..0000000000 --- a/core/modules/field_layout/src/Form/FieldLayoutEntityDisplayFormTrait.php +++ /dev/null @@ -1,179 +0,0 @@ -layoutPluginManager->getDefinition($this->getEntity()->getLayoutId()); - foreach ($layout_definition->getRegions() as $name => $region) { - $regions[$name] = [ - 'title' => $region['label'], - 'message' => $this->t('No field is displayed.'), - ]; - } - - $regions['hidden'] = [ - 'title' => $this->t('Disabled', [], ['context' => 'Plural']), - 'message' => $this->t('No field is hidden.'), - ]; - - return $regions; - } - - /** - * Overrides \Drupal\field_ui\Form\EntityDisplayFormBase::form(). - */ - public function form(array $form, FormStateInterface $form_state) { - $form = parent::form($form, $form_state); - - $form['field_layouts'] = [ - '#type' => 'details', - '#title' => $this->t('Layout settings'), - ]; - - $layout_plugin = $this->getLayout($this->getEntity(), $form_state); - - $form['field_layouts']['field_layout'] = [ - '#type' => 'select', - '#title' => $this->t('Select a layout'), - '#options' => $this->layoutPluginManager->getLayoutOptions(), - '#default_value' => $layout_plugin->getPluginId(), - '#ajax' => [ - 'callback' => '::settingsAjax', - 'wrapper' => 'field-layout-settings-wrapper', - 'trigger_as' => ['name' => 'field_layout_change'], - ], - ]; - $form['field_layouts']['submit'] = [ - '#type' => 'submit', - '#name' => 'field_layout_change', - '#value' => $this->t('Change layout'), - '#submit' => ['::settingsAjaxSubmit'], - '#attributes' => ['class' => ['js-hide']], - '#ajax' => [ - 'callback' => '::settingsAjax', - 'wrapper' => 'field-layout-settings-wrapper', - ], - ]; - - $form['field_layouts']['settings_wrapper'] = [ - '#type' => 'container', - '#id' => 'field-layout-settings-wrapper', - '#tree' => TRUE, - ]; - - $form['field_layouts']['settings_wrapper']['icon'] = $layout_plugin->getPluginDefinition()->getIcon(); - - if ($layout_plugin instanceof PluginFormInterface) { - $form['field_layouts']['settings_wrapper']['layout_settings'] = []; - $subform_state = SubformState::createForSubform($form['field_layouts']['settings_wrapper']['layout_settings'], $form, $form_state); - $form['field_layouts']['settings_wrapper']['layout_settings'] = $layout_plugin->buildConfigurationForm($form['field_layouts']['settings_wrapper']['layout_settings'], $subform_state); - } - - return $form; - } - - /** - * Gets the layout plugin for the currently selected field layout. - * - * @param \Drupal\field_layout\Display\EntityDisplayWithLayoutInterface $entity - * The current form entity. - * @param \Drupal\Core\Form\FormStateInterface $form_state - * The current state of the form. - * - * @return \Drupal\Core\Layout\LayoutInterface - * The layout plugin. - */ - protected function getLayout(EntityDisplayWithLayoutInterface $entity, FormStateInterface $form_state) { - if (!$layout_plugin = $form_state->get('layout_plugin')) { - $stored_layout_id = $entity->getLayoutId(); - // Use selected layout if it exists, falling back to the stored layout. - $layout_id = $form_state->getValue('field_layout', $stored_layout_id); - // If the current layout is the stored layout, use the stored layout - // settings. Otherwise leave the settings empty. - $layout_settings = $layout_id === $stored_layout_id ? $entity->getLayoutSettings() : []; - - $layout_plugin = $this->layoutPluginManager->createInstance($layout_id, $layout_settings); - $form_state->set('layout_plugin', $layout_plugin); - } - return $layout_plugin; - } - - /** - * Ajax callback for the field layout settings form. - */ - public static function settingsAjax($form, FormStateInterface $form_state) { - return $form['field_layouts']['settings_wrapper']; - } - - /** - * Submit handler for the non-JS case. - */ - public function settingsAjaxSubmit($form, FormStateInterface $form_state) { - $form_state->set('layout_plugin', NULL); - $form_state->setRebuild(); - } - - /** - * Overrides \Drupal\field_ui\Form\EntityDisplayFormBase::validateForm(). - */ - public function validateForm(array &$form, FormStateInterface $form_state) { - parent::validateForm($form, $form_state); - - $layout_plugin = $this->getLayout($this->getEntity(), $form_state); - if ($layout_plugin instanceof PluginFormInterface) { - $subform_state = SubformState::createForSubform($form['field_layouts']['settings_wrapper']['layout_settings'], $form, $form_state); - $layout_plugin->validateConfigurationForm($form['field_layouts']['settings_wrapper']['layout_settings'], $subform_state); - } - } - - /** - * Overrides \Drupal\field_ui\Form\EntityDisplayFormBase::submitForm(). - */ - public function submitForm(array &$form, FormStateInterface $form_state) { - parent::submitForm($form, $form_state); - - $entity = $this->getEntity(); - $layout_plugin = $this->getLayout($entity, $form_state); - if ($layout_plugin instanceof PluginFormInterface) { - $subform_state = SubformState::createForSubform($form['field_layouts']['settings_wrapper']['layout_settings'], $form, $form_state); - $layout_plugin->submitConfigurationForm($form['field_layouts']['settings_wrapper']['layout_settings'], $subform_state); - } - - $entity->setLayout($layout_plugin); - } - - /** - * Gets the form entity. - * - * @return \Drupal\field_layout\Display\EntityDisplayWithLayoutInterface - * The current form entity. - */ - abstract public function getEntity(); - -} diff --git a/core/modules/field_layout/src/Form/FieldLayoutEntityFormDisplayEditForm.php b/core/modules/field_layout/src/Form/FieldLayoutEntityFormDisplayEditForm.php deleted file mode 100644 index bb8bc221ea..0000000000 --- a/core/modules/field_layout/src/Form/FieldLayoutEntityFormDisplayEditForm.php +++ /dev/null @@ -1,54 +0,0 @@ -layoutPluginManager = $layout_plugin_manager; - } - - /** - * {@inheritdoc} - */ - public static function create(ContainerInterface $container) { - return new static( - $container->get('plugin.manager.field.field_type'), - $container->get('plugin.manager.field.widget'), - $container->get('plugin.manager.core.layout'), - $container->get('entity_display.repository'), - $container->get('entity_field.manager') - ); - } - -} diff --git a/core/modules/field_layout/src/Form/FieldLayoutEntityViewDisplayEditForm.php b/core/modules/field_layout/src/Form/FieldLayoutEntityViewDisplayEditForm.php deleted file mode 100644 index 628b1ae917..0000000000 --- a/core/modules/field_layout/src/Form/FieldLayoutEntityViewDisplayEditForm.php +++ /dev/null @@ -1,54 +0,0 @@ -layoutPluginManager = $layout_plugin_manager; - } - - /** - * {@inheritdoc} - */ - public static function create(ContainerInterface $container) { - return new static( - $container->get('plugin.manager.field.field_type'), - $container->get('plugin.manager.field.formatter'), - $container->get('plugin.manager.core.layout'), - $container->get('entity_display.repository'), - $container->get('entity_field.manager') - ); - } - -} diff --git a/core/modules/field_layout/tests/modules/field_layout_test/config/schema/field_layout_test.schema.yml b/core/modules/field_layout/tests/modules/field_layout_test/config/schema/field_layout_test.schema.yml deleted file mode 100644 index dc95ab32fd..0000000000 --- a/core/modules/field_layout/tests/modules/field_layout_test/config/schema/field_layout_test.schema.yml +++ /dev/null @@ -1,7 +0,0 @@ -layout_plugin.settings.test_layout_main_and_footer: - type: layout_plugin.settings - label: 'Layout test plugin settings' - mapping: - setting_1: - type: string - label: 'Setting 1' diff --git a/core/modules/field_layout/tests/modules/field_layout_test/field_layout_test.info.yml b/core/modules/field_layout/tests/modules/field_layout_test/field_layout_test.info.yml deleted file mode 100644 index 47364228fd..0000000000 --- a/core/modules/field_layout/tests/modules/field_layout_test/field_layout_test.info.yml +++ /dev/null @@ -1,7 +0,0 @@ -name: 'Field Layout test' -type: module -description: 'Support module for Field Layout tests.' -package: Testing -version: VERSION -dependencies: - - drupal:entity_test diff --git a/core/modules/field_layout/tests/modules/field_layout_test/field_layout_test.module b/core/modules/field_layout/tests/modules/field_layout_test/field_layout_test.module deleted file mode 100644 index 6905c3daac..0000000000 --- a/core/modules/field_layout/tests/modules/field_layout_test/field_layout_test.module +++ /dev/null @@ -1,16 +0,0 @@ -get('field_layout_test.alter_regions') && isset($definitions['layout_onecol'])) { - $definitions['layout_onecol']->setRegions(['foo' => ['label' => 'Foo']]); - } -} diff --git a/core/modules/field_layout/tests/src/Functional/FieldLayoutTest.php b/core/modules/field_layout/tests/src/Functional/FieldLayoutTest.php deleted file mode 100644 index 8c739e1a27..0000000000 --- a/core/modules/field_layout/tests/src/Functional/FieldLayoutTest.php +++ /dev/null @@ -1,102 +0,0 @@ -createContentType([ - 'type' => 'article', - ]); - $this->createNode([ - 'type' => 'article', - 'title' => 'The node title', - 'body' => [ - ['value' => 'The node body'], - ], - ]); - $this->drupalLogin($this->drupalCreateUser([ - 'access administration pages', - 'administer content types', - 'administer nodes', - 'administer node fields', - 'administer node display', - 'administer node form display', - 'view the administration theme', - ])); - } - - /** - * Tests an entity type that has fields shown by default. - */ - public function testNodeView() { - // By default, the one-column layout is used. - $this->drupalGet('node/1'); - $this->assertSession()->elementExists('css', '.layout--onecol'); - $this->assertSession()->elementExists('css', '.layout__region--content .field--name-body'); - - $this->drupalGet('admin/structure/types/manage/article/display'); - $this->assertEquals(['Content', 'Disabled'], $this->getRegionTitles()); - $this->assertSession()->optionExists('fields[body][region]', 'content'); - } - - /** - * Tests that changes to the regions still leave the fields visible. - */ - public function testRegionChanges() { - $this->drupalGet('admin/structure/types/manage/article/display'); - $this->assertEquals(['Content', 'Disabled'], $this->getRegionTitles()); - $this->assertSession()->optionExists('fields[body][region]', 'content'); - - \Drupal::state()->set('field_layout_test.alter_regions', TRUE); - \Drupal::service('plugin.cache_clearer')->clearCachedDefinitions(); - - $this->drupalGet('admin/structure/types/manage/article/display'); - $this->assertEquals(['Foo', 'Disabled'], $this->getRegionTitles()); - $this->assertSession()->optionExists('fields[body][region]', 'hidden'); - } - - /** - * Gets the region titles on the page. - * - * @return string[] - * An array of region titles. - */ - protected function getRegionTitles() { - $region_titles = []; - $region_title_elements = $this->getSession()->getPage()->findAll('css', '.region-title td'); - /** @var \Behat\Mink\Element\NodeElement[] $region_title_elements */ - foreach ($region_title_elements as $region_title_element) { - $region_titles[] = $region_title_element->getText(); - } - return $region_titles; - } - -} diff --git a/core/modules/field_layout/tests/src/FunctionalJavascript/FieldLayoutTest.php b/core/modules/field_layout/tests/src/FunctionalJavascript/FieldLayoutTest.php deleted file mode 100644 index 7ad41defd3..0000000000 --- a/core/modules/field_layout/tests/src/FunctionalJavascript/FieldLayoutTest.php +++ /dev/null @@ -1,316 +0,0 @@ - 'The name for this entity', - 'field_test_text' => [ - ['value' => 'The field test text value'], - ], - ]); - $entity->save(); - $this->drupalLogin($this->drupalCreateUser([ - 'access administration pages', - 'view test entity', - 'administer entity_test content', - 'administer entity_test fields', - 'administer entity_test display', - 'administer entity_test form display', - 'view the administration theme', - ])); - } - - /** - * Tests that layouts are unique per view mode. - */ - public function testEntityViewModes() { - // By default, the field is not visible. - $this->drupalGet('entity_test/1/test'); - $this->assertSession()->elementNotExists('css', '.layout__region--content .field--name-field-test-text'); - $this->drupalGet('entity_test/1'); - $this->assertSession()->elementNotExists('css', '.layout__region--content .field--name-field-test-text'); - - // Change the layout for the "test" view mode. See - // core.entity_view_mode.entity_test.test.yml. - $this->drupalGet('entity_test/structure/entity_test/display'); - $this->click('#edit-modes'); - $this->getSession()->getPage()->checkField('display_modes_custom[test]'); - $this->submitForm([], 'Save'); - $this->clickLink('configure them'); - $this->getSession()->getPage()->pressButton('Show row weights'); - $this->getSession()->getPage()->selectFieldOption('fields[field_test_text][region]', 'content'); - $this->assertSession()->assertWaitOnAjaxRequest(); - $this->submitForm([], 'Save'); - - // Each view mode has a different layout. - $this->drupalGet('entity_test/1/test'); - $this->assertSession()->elementExists('css', '.layout__region--content .field--name-field-test-text'); - $this->drupalGet('entity_test/1'); - $this->assertSession()->elementNotExists('css', '.layout__region--content .field--name-field-test-text'); - } - - /** - * Tests the use of field layout for entity form displays. - */ - public function testEntityForm() { - // By default, the one-column layout is used. - $this->drupalGet('entity_test/manage/1/edit'); - $this->assertFieldInRegion('field_test_text[0][value]', 'content'); - - // The one-column layout is in use. - $this->drupalGet('entity_test/structure/entity_test/form-display'); - $this->assertEquals(['Content', 'Disabled'], $this->getRegionTitles()); - - // Switch the layout to two columns. - $this->click('#edit-field-layouts'); - $this->getSession()->getPage()->selectFieldOption('field_layout', 'layout_twocol'); - $this->assertSession()->assertWaitOnAjaxRequest(); - $this->submitForm([], 'Save'); - - // The field is moved to the default region for the new layout. - $this->assertSession()->pageTextContains('Your settings have been saved.'); - $this->assertEquals(['Top', 'First', 'Second', 'Bottom', 'Disabled'], $this->getRegionTitles()); - - $this->drupalGet('entity_test/manage/1/edit'); - // No fields are visible, and the regions don't display when empty. - $this->assertFieldInRegion('field_test_text[0][value]', 'first'); - $this->assertSession()->elementExists('css', '.layout__region--first .field--name-field-test-text'); - - // After a refresh the new regions are still there. - $this->drupalGet('entity_test/structure/entity_test/form-display'); - $this->assertEquals(['Top', 'First', 'Second', 'Bottom', 'Disabled'], $this->getRegionTitles()); - $this->assertSession()->waitForElement('css', '.tabledrag-handle'); - $id = $this->getSession()->getPage()->find('css', '[name="form_build_id"]')->getValue(); - - // Drag the field to the second region. - $field_test_text_row = $this->getSession()->getPage()->find('css', '#field-test-text'); - $second_region_row = $this->getSession()->getPage()->find('css', '.region-second-message'); - $field_test_text_row->find('css', '.handle')->dragTo($second_region_row); - $this->assertSession()->assertWaitOnAjaxRequest(); - $this->assertSession()->waitForElement('css', "[name='form_build_id']:not([value='$id'])"); - $this->submitForm([], 'Save'); - $this->assertSession()->pageTextContains('Your settings have been saved.'); - - // The new layout is used. - $this->drupalGet('entity_test/manage/1/edit'); - $this->assertSession()->elementExists('css', '.layout__region--second .field--name-field-test-text'); - $this->assertFieldInRegion('field_test_text[0][value]', 'second'); - - // Move the field to the second region without tabledrag. - $this->drupalGet('entity_test/structure/entity_test/form-display'); - $this->getSession()->getPage()->pressButton('Show row weights'); - $this->getSession()->getPage()->selectFieldOption('fields[field_test_text][region]', 'second'); - $this->assertSession()->assertWaitOnAjaxRequest(); - $this->submitForm([], 'Save'); - $this->assertSession()->pageTextContains('Your settings have been saved.'); - - // The updated region is used. - $this->drupalGet('entity_test/manage/1/edit'); - $this->assertFieldInRegion('field_test_text[0][value]', 'second'); - - // The layout is still in use without Field UI. - $this->container->get('module_installer')->uninstall(['field_ui']); - $this->drupalGet('entity_test/manage/1/edit'); - $this->assertFieldInRegion('field_test_text[0][value]', 'second'); - } - - /** - * Tests the use of field layout for entity view displays. - */ - public function testEntityView() { - // The one-column layout is in use. - $this->drupalGet('entity_test/structure/entity_test/display'); - $this->assertEquals(['Content', 'Disabled'], $this->getRegionTitles()); - - // Switch the layout to two columns. - $this->click('#edit-field-layouts'); - $this->getSession()->getPage()->selectFieldOption('field_layout', 'layout_twocol'); - $this->assertSession()->assertWaitOnAjaxRequest(); - $this->submitForm([], 'Save'); - - $this->assertSession()->pageTextContains('Your settings have been saved.'); - $this->assertEquals(['Top', 'First', 'Second', 'Bottom', 'Disabled'], $this->getRegionTitles()); - - $this->drupalGet('entity_test/1'); - // No fields are visible, and the regions don't display when empty. - $this->assertSession()->elementNotExists('css', '.layout--twocol'); - $this->assertSession()->elementNotExists('css', '.layout__region'); - $this->assertSession()->elementNotExists('css', '.field--name-field-test-text'); - - // After a refresh the new regions are still there. - $this->drupalGet('entity_test/structure/entity_test/display'); - $this->assertEquals(['Top', 'First', 'Second', 'Bottom', 'Disabled'], $this->getRegionTitles()); - $this->assertSession()->waitForElement('css', '.tabledrag-handle'); - $id = $this->getSession()->getPage()->find('css', '[name="form_build_id"]')->getValue(); - - // Drag the field to the first region. - $this->assertTrue($this->assertSession()->optionExists('fields[field_test_text][region]', 'hidden')->isSelected()); - $field_test_text_row = $this->getSession()->getPage()->find('css', '#field-test-text'); - $first_region_row = $this->getSession()->getPage()->find('css', '.region-first-message'); - $field_test_text_row->find('css', '.handle')->dragTo($first_region_row); - $this->assertSession()->assertWaitOnAjaxRequest(); - $this->assertFalse($this->assertSession()->optionExists('fields[field_test_text][region]', 'hidden')->isSelected()); - $this->assertSession()->waitForElement('css', "[name='form_build_id']:not([value='$id'])"); - $this->submitForm([], 'Save'); - $this->assertSession()->pageTextContains('Your settings have been saved.'); - - // The new layout is used. - $this->drupalGet('entity_test/1'); - $this->assertSession()->elementExists('css', '.layout--twocol'); - $this->assertSession()->elementExists('css', '.layout__region--first .field--name-field-test-text'); - - // Move the field to the second region without tabledrag. - $this->drupalGet('entity_test/structure/entity_test/display'); - $this->getSession()->getPage()->pressButton('Show row weights'); - $this->getSession()->getPage()->selectFieldOption('fields[field_test_text][region]', 'second'); - $this->assertSession()->assertWaitOnAjaxRequest(); - $this->submitForm([], 'Save'); - $this->assertSession()->pageTextContains('Your settings have been saved.'); - - // The updated region is used. - $this->drupalGet('entity_test/1'); - $this->assertSession()->elementExists('css', '.layout__region--second .field--name-field-test-text'); - - // The layout is still in use without Field UI. - $this->container->get('module_installer')->uninstall(['field_ui']); - $this->drupalGet('entity_test/1'); - $this->assertSession()->elementExists('css', '.layout--twocol'); - $this->assertSession()->elementExists('css', '.layout__region--second .field--name-field-test-text'); - } - - /** - * Tests layout plugins with forms. - */ - public function testLayoutForms() { - $this->drupalGet('entity_test/structure/entity_test/display'); - // Switch to a field layout with settings. - $this->click('#edit-field-layouts'); - - // Test switching between layouts with and without forms. - $this->getSession()->getPage()->selectFieldOption('field_layout', 'layout_test_plugin'); - $this->assertSession()->assertWaitOnAjaxRequest(); - $this->assertSession()->fieldExists('settings_wrapper[layout_settings][setting_1]'); - - $this->getSession()->getPage()->selectFieldOption('field_layout', 'layout_test_2col'); - $this->assertSession()->assertWaitOnAjaxRequest(); - $this->assertSession()->fieldNotExists('settings_wrapper[layout_settings][setting_1]'); - - $this->getSession()->getPage()->selectFieldOption('field_layout', 'layout_test_plugin'); - $this->assertSession()->assertWaitOnAjaxRequest(); - $this->assertSession()->fieldExists('settings_wrapper[layout_settings][setting_1]'); - - // Move the test field to the content region. - $this->getSession()->getPage()->pressButton('Show row weights'); - $this->getSession()->getPage()->selectFieldOption('fields[field_test_text][region]', 'content'); - $this->assertSession()->assertWaitOnAjaxRequest(); - $this->submitForm([], 'Save'); - - $this->drupalGet('entity_test/1'); - $this->assertSession()->pageTextContains('Blah: Default'); - - // Update the field layout settings. - $this->drupalGet('entity_test/structure/entity_test/display'); - $this->click('#edit-field-layouts'); - $this->getSession()->getPage()->fillField('settings_wrapper[layout_settings][setting_1]', 'Test text'); - $this->submitForm([], 'Save'); - - $this->drupalGet('entity_test/1'); - $this->assertSession()->pageTextContains('Blah: Test text'); - } - - /** - * Tests changing the formatter and region at the same time. - */ - public function testChangingFormatterAndRegion() { - $assert_session = $this->assertSession(); - $page = $this->getSession()->getPage(); - - // Add the test field to the content region. - $this->drupalGet('entity_test/structure/entity_test/display'); - $page->find('css', '#field-test-text .handle')->dragTo($page->find('css', '.region-content-message')); - $assert_session->assertWaitOnAjaxRequest(); - $page->pressButton('Save'); - $assert_session->fieldValueEquals('fields[field_test_text][region]', 'content'); - $assert_session->fieldValueEquals('fields[field_test_text][type]', 'text_default'); - - // Switch the layout to two columns. - $this->click('#edit-field-layouts'); - $page->selectFieldOption('field_layout', 'layout_twocol'); - $assert_session->assertWaitOnAjaxRequest(); - $page->pressButton('Save'); - $assert_session->fieldValueEquals('fields[field_test_text][region]', 'first'); - - // Change the formatter and move to another region. - $page->selectFieldOption('fields[field_test_text][type]', 'text_trimmed'); - $assert_session->assertWaitOnAjaxRequest(); - $page->find('css', '#field-test-text .handle')->dragTo($page->find('css', '.region-second-message')); - $assert_session->assertWaitOnAjaxRequest(); - $page->pressButton('Save'); - - // Assert that both the formatter and region change are persisted. - $assert_session->fieldValueEquals('fields[field_test_text][region]', 'second'); - $assert_session->fieldValueEquals('fields[field_test_text][type]', 'text_trimmed'); - } - - /** - * Gets the region titles on the page. - * - * @return string[] - * An array of region titles. - */ - protected function getRegionTitles() { - $region_titles = []; - $region_title_elements = $this->getSession()->getPage()->findAll('css', '.region-title td'); - /** @var \Behat\Mink\Element\NodeElement[] $region_title_elements */ - foreach ($region_title_elements as $region_title_element) { - $region_titles[] = $region_title_element->getText(); - } - return $region_titles; - } - - /** - * Asserts that a field exists in a given region. - * - * @param string $field_selector - * The field selector, one of field id|name|label|value. - * @param string $region_name - * The machine name of the region. - */ - protected function assertFieldInRegion($field_selector, $region_name) { - $region_element = $this->getSession()->getPage()->find('css', ".layout__region--$region_name"); - $this->assertNotNull($region_element); - $this->assertSession()->fieldExists($field_selector, $region_element); - } - -} diff --git a/core/modules/field_layout/tests/src/Unit/FieldLayoutBuilderTest.php b/core/modules/field_layout/tests/src/Unit/FieldLayoutBuilderTest.php deleted file mode 100644 index 8b074d5a07..0000000000 --- a/core/modules/field_layout/tests/src/Unit/FieldLayoutBuilderTest.php +++ /dev/null @@ -1,330 +0,0 @@ -pluginDefinition = new LayoutDefinition([ - 'library' => 'field_layout/drupal.layout.twocol', - 'theme_hook' => 'layout__twocol', - 'regions' => [ - 'left' => [ - 'label' => 'Left', - ], - 'right' => [ - 'label' => 'Right', - ], - ], - ]); - $this->layoutPlugin = new LayoutDefault([], 'two_column', $this->pluginDefinition); - - $this->layoutPluginManager = $this->prophesize(LayoutPluginManagerInterface::class); - $this->layoutPluginManager->getDefinition('unknown', FALSE)->willReturn(NULL); - $this->layoutPluginManager->getDefinition('two_column', FALSE)->willReturn($this->pluginDefinition); - - $this->entityFieldManager = $this->prophesize(EntityFieldManagerInterface::class); - - $this->fieldLayoutBuilder = new FieldLayoutBuilder($this->layoutPluginManager->reveal(), $this->entityFieldManager->reveal()); - } - - /** - * @covers ::buildView - * @covers ::getFields - */ - public function testBuildView() { - $definitions = []; - $non_configurable_field_definition = $this->prophesize(FieldDefinitionInterface::class); - $non_configurable_field_definition->isDisplayConfigurable('view')->willReturn(FALSE); - $definitions['non_configurable_field'] = $non_configurable_field_definition->reveal(); - $definitions['non_configurable_field_with_extra_field'] = $non_configurable_field_definition->reveal(); - $this->entityFieldManager->getFieldDefinitions('the_entity_type_id', 'the_entity_type_bundle')->willReturn($definitions); - $extra_fields = []; - $extra_fields['non_configurable_field_with_extra_field'] = [ - 'label' => 'This non-configurable field is also defined in hook_entity_extra_field_info()', - ]; - $this->entityFieldManager->getExtraFields('the_entity_type_id', 'the_entity_type_bundle')->willReturn($extra_fields); - - $build = [ - 'test1' => [ - '#markup' => 'Test1', - ], - 'test2' => [ - '#markup' => 'Test2', - ], - 'non_configurable_field' => [ - '#markup' => 'Non-configurable', - ], - 'non_configurable_field_with_extra_field' => [ - '#markup' => 'Non-configurable with extra field', - ], - ]; - - $display = $this->prophesize(EntityDisplayWithLayoutInterface::class); - $display->getTargetEntityTypeId()->willReturn('the_entity_type_id'); - $display->getTargetBundle()->willReturn('the_entity_type_bundle'); - $display->getLayout()->willReturn($this->layoutPlugin); - $display->getLayoutId()->willReturn('two_column'); - $display->getLayoutSettings()->willReturn([]); - $display->getComponents()->willReturn([ - 'test1' => [ - 'region' => 'right', - ], - 'test2' => [ - 'region' => 'unknown_region', - ], - 'non_configurable_field' => [ - 'region' => 'left', - ], - 'non_configurable_field_with_extra_field' => [ - 'region' => 'left', - ], - ]); - - $expected = [ - 'test2' => [ - '#markup' => 'Test2', - ], - 'non_configurable_field' => [ - '#markup' => 'Non-configurable', - ], - '_field_layout' => [ - 'left' => [ - 'non_configurable_field_with_extra_field' => [ - '#markup' => 'Non-configurable with extra field', - ], - ], - 'right' => [ - 'test1' => [ - '#markup' => 'Test1', - ], - ], - '#settings' => [ - 'label' => '', - ], - '#layout' => $this->pluginDefinition, - '#theme' => 'layout__twocol', - '#attached' => [ - 'library' => [ - 'field_layout/drupal.layout.twocol', - ], - ], - ], - ]; - $this->fieldLayoutBuilder->buildView($build, $display->reveal()); - $this->assertEquals($expected, $build); - $this->assertSame($expected, $build); - } - - /** - * @covers ::buildForm - * @covers ::getFields - */ - public function testBuildForm() { - $definitions = []; - $non_configurable_field_definition = $this->prophesize(FieldDefinitionInterface::class); - $non_configurable_field_definition->isDisplayConfigurable('form')->willReturn(FALSE); - $definitions['non_configurable_field'] = $non_configurable_field_definition->reveal(); - $this->entityFieldManager->getFieldDefinitions('the_entity_type_id', 'the_entity_type_bundle')->willReturn($definitions); - $this->entityFieldManager->getExtraFields('the_entity_type_id', 'the_entity_type_bundle')->willReturn([]); - - $build = [ - 'test1' => [ - '#markup' => 'Test1', - ], - 'test2' => [ - '#markup' => 'Test2', - '#group' => 'existing_group', - ], - 'test3' => [ - '#markup' => 'Test3', - ], - 'field_layout' => [ - '#markup' => 'Field created through the UI happens to be named "Layout"', - ], - 'non_configurable_field' => [ - '#markup' => 'Non-configurable', - ], - ]; - - $display = $this->prophesize(EntityDisplayWithLayoutInterface::class); - $display->getTargetEntityTypeId()->willReturn('the_entity_type_id'); - $display->getTargetBundle()->willReturn('the_entity_type_bundle'); - $display->getLayout()->willReturn($this->layoutPlugin); - $display->getLayoutId()->willReturn('two_column'); - $display->getLayoutSettings()->willReturn([]); - $display->getComponents()->willReturn([ - 'test1' => [ - 'region' => 'right', - ], - 'test2' => [ - 'region' => 'left', - ], - 'test3' => [ - 'region' => 'unknown_region', - ], - 'field_layout' => [ - 'region' => 'right', - ], - 'non_configurable_field' => [ - 'region' => 'left', - ], - ]); - - $expected = [ - 'test1' => [ - '#markup' => 'Test1', - '#group' => 'right', - ], - 'test2' => [ - '#markup' => 'Test2', - '#group' => 'existing_group', - ], - 'test3' => [ - '#markup' => 'Test3', - ], - 'field_layout' => [ - '#markup' => 'Field created through the UI happens to be named "Layout"', - '#group' => 'right', - ], - 'non_configurable_field' => [ - '#markup' => 'Non-configurable', - ], - '_field_layout' => [ - 'left' => [ - '#process' => ['\Drupal\Core\Render\Element\RenderElement::processGroup'], - '#pre_render' => ['\Drupal\Core\Render\Element\RenderElement::preRenderGroup'], - ], - 'right' => [ - '#process' => ['\Drupal\Core\Render\Element\RenderElement::processGroup'], - '#pre_render' => ['\Drupal\Core\Render\Element\RenderElement::preRenderGroup'], - ], - '#settings' => [ - 'label' => '', - ], - '#layout' => $this->pluginDefinition, - '#theme' => 'layout__twocol', - '#attached' => [ - 'library' => [ - 'field_layout/drupal.layout.twocol', - ], - ], - ], - ]; - $this->fieldLayoutBuilder->buildForm($build, $display->reveal()); - $this->assertEquals($expected, $build); - $this->assertSame($expected, $build); - } - - /** - * @covers ::buildForm - */ - public function testBuildFormEmpty() { - $definitions = []; - $non_configurable_field_definition = $this->prophesize(FieldDefinitionInterface::class); - $non_configurable_field_definition->isDisplayConfigurable('form')->willReturn(FALSE); - $definitions['non_configurable_field'] = $non_configurable_field_definition->reveal(); - $this->entityFieldManager->getFieldDefinitions('the_entity_type_id', 'the_entity_type_bundle')->willReturn($definitions); - $this->entityFieldManager->getExtraFields('the_entity_type_id', 'the_entity_type_bundle')->willReturn([]); - - $build = [ - 'non_configurable_field' => [ - '#markup' => 'Non-configurable', - ], - ]; - - $display = $this->prophesize(EntityDisplayWithLayoutInterface::class); - $display->getTargetEntityTypeId()->willReturn('the_entity_type_id'); - $display->getTargetBundle()->willReturn('the_entity_type_bundle'); - $display->getLayout()->willReturn($this->layoutPlugin); - $display->getLayoutId()->willReturn('two_column'); - $display->getLayoutSettings()->willReturn([]); - $display->getComponents()->willReturn([ - 'test1' => [ - 'region' => 'right', - ], - 'non_configurable_field' => [ - 'region' => 'left', - ], - ]); - - $expected = [ - 'non_configurable_field' => [ - '#markup' => 'Non-configurable', - ], - ]; - $this->fieldLayoutBuilder->buildForm($build, $display->reveal()); - $this->assertSame($expected, $build); - } - - /** - * @covers ::buildForm - */ - public function testBuildFormNoLayout() { - $this->entityFieldManager->getFieldDefinitions(Argument::any(), Argument::any())->shouldNotBeCalled(); - - $build = [ - 'test1' => [ - '#markup' => 'Test1', - ], - ]; - - $display = $this->prophesize(EntityDisplayWithLayoutInterface::class); - $display->getLayoutId()->willReturn('unknown'); - $display->getLayoutSettings()->willReturn([]); - $display->getComponents()->shouldNotBeCalled(); - - $expected = [ - 'test1' => [ - '#markup' => 'Test1', - ], - ]; - $this->fieldLayoutBuilder->buildForm($build, $display->reveal()); - $this->assertSame($expected, $build); - } - -} diff --git a/core/modules/field_ui/src/Form/EntityDisplayFormBase.php b/core/modules/field_ui/src/Form/EntityDisplayFormBase.php index 97d234aad4..c077b049b6 100644 --- a/core/modules/field_ui/src/Form/EntityDisplayFormBase.php +++ b/core/modules/field_ui/src/Form/EntityDisplayFormBase.php @@ -5,6 +5,7 @@ use Drupal\Component\Plugin\Factory\DefaultFactory; use Drupal\Component\Plugin\PluginManagerBase; use Drupal\Core\Entity\EntityFieldManagerInterface; +use Drupal\Core\Entity\Display\EntityDisplayWithLayoutInterface; use Drupal\Core\Entity\EntityForm; use Drupal\Core\Entity\EntityInterface; use Drupal\Core\Entity\EntityDisplayRepositoryInterface; @@ -13,6 +14,9 @@ use Drupal\Core\Field\FieldTypePluginManagerInterface; use Drupal\Core\Field\PluginSettingsInterface; use Drupal\Core\Form\FormStateInterface; +use Drupal\Core\Form\SubformState; +use Drupal\Core\Layout\LayoutPluginManagerInterface; +use Drupal\Core\Plugin\PluginFormInterface; use Drupal\Core\Routing\RouteMatchInterface; use Drupal\field_ui\FieldUI; @@ -60,7 +64,7 @@ abstract class EntityDisplayFormBase extends EntityForm { /** * The entity being used by this form. * - * @var \Drupal\Core\Entity\Display\EntityDisplayInterface + * @var \Drupal\Core\Entity\Display\EntityDisplayWithLayoutInterface */ protected $entity; @@ -75,12 +79,19 @@ abstract class EntityDisplayFormBase extends EntityForm { * (optional) The entity display_repository. * @param \Drupal\Core\Entity\EntityFieldManagerInterface|null $entity_field_manager * (optional) The entity field manager. + * @param \Drupal\Core\Layout\LayoutPluginManagerInterface $layout_plugin_manager + * The layout plugin manager. */ - public function __construct(FieldTypePluginManagerInterface $field_type_manager, PluginManagerBase $plugin_manager, EntityDisplayRepositoryInterface $entity_display_repository, EntityFieldManagerInterface $entity_field_manager) { + public function __construct(FieldTypePluginManagerInterface $field_type_manager, PluginManagerBase $plugin_manager, EntityDisplayRepositoryInterface $entity_display_repository = NULL, EntityFieldManagerInterface $entity_field_manager = NULL, LayoutPluginManagerInterface $layout_plugin_manager = NULL) { $this->fieldTypes = $field_type_manager->getDefinitions(); $this->pluginManager = $plugin_manager; $this->entityDisplayRepository = $entity_display_repository; $this->entityFieldManager = $entity_field_manager; + if (!$layout_plugin_manager) { + @trigger_error('Calling EntityDisplayFormBase::__construct() with the $layout_plugin_manager argument is supported in Drupal 8.7.0 and will be required before Drupal 9.0.0. See https://www.drupal.org/node/@todo.', E_USER_DEPRECATED); + $layout_plugin_manager = \Drupal::service('plugin.manager.core.layout'); + } + $this->layoutPluginManager = $layout_plugin_manager; } /** @@ -112,17 +123,22 @@ public function getEntityFromRouteMatch(RouteMatchInterface $route_match, $entit * @endcode */ public function getRegions() { - return [ - 'content' => [ - 'title' => $this->t('Content'), - 'invisible' => TRUE, + $regions = []; + + $layout_definition = $this->entity->getLayout()->getPluginDefinition(); + foreach ($layout_definition->getRegions() as $name => $region) { + $regions[$name] = [ + 'title' => $region['label'], 'message' => $this->t('No field is displayed.'), - ], - 'hidden' => [ - 'title' => $this->t('Disabled', [], ['context' => 'Plural']), - 'message' => $this->t('No field is hidden.'), - ], + ]; + } + + $regions['hidden'] = [ + 'title' => $this->t('Disabled', [], ['context' => 'Plural']), + 'message' => $this->t('No field is hidden.'), ]; + + return $regions; } /** diff --git a/core/modules/field_ui/src/Form/EntityFormDisplayEditForm.php b/core/modules/field_ui/src/Form/EntityFormDisplayEditForm.php index 230b927119..f5408dee19 100644 --- a/core/modules/field_ui/src/Form/EntityFormDisplayEditForm.php +++ b/core/modules/field_ui/src/Form/EntityFormDisplayEditForm.php @@ -29,7 +29,8 @@ public static function create(ContainerInterface $container) { $container->get('plugin.manager.field.field_type'), $container->get('plugin.manager.field.widget'), $container->get('entity_display.repository'), - $container->get('entity_field.manager') + $container->get('entity_field.manager'), + $container->get('plugin.manager.core.layout') ); } diff --git a/core/modules/field_ui/src/Form/EntityViewDisplayEditForm.php b/core/modules/field_ui/src/Form/EntityViewDisplayEditForm.php index eb5ecac690..5c22ff9f86 100644 --- a/core/modules/field_ui/src/Form/EntityViewDisplayEditForm.php +++ b/core/modules/field_ui/src/Form/EntityViewDisplayEditForm.php @@ -29,7 +29,8 @@ public static function create(ContainerInterface $container) { $container->get('plugin.manager.field.field_type'), $container->get('plugin.manager.field.formatter'), $container->get('entity_display.repository'), - $container->get('entity_field.manager') + $container->get('entity_field.manager'), + $container->get('plugin.manager.core.layout') ); } diff --git a/core/modules/field_ui/tests/src/Functional/EntityDisplayTest.php b/core/modules/field_ui/tests/src/Functional/EntityDisplayTest.php index d02ba07de4..a4f322bb3e 100644 --- a/core/modules/field_ui/tests/src/Functional/EntityDisplayTest.php +++ b/core/modules/field_ui/tests/src/Functional/EntityDisplayTest.php @@ -14,7 +14,7 @@ class EntityDisplayTest extends BrowserTestBase { /** * {@inheritdoc} */ - protected static $modules = ['field_ui', 'entity_test']; + public static $modules = ['field_ui', 'entity_test', 'layout_test']; /** * {@inheritdoc} diff --git a/core/modules/field_ui/tests/src/FunctionalJavascript/EntityDisplayTest.php b/core/modules/field_ui/tests/src/FunctionalJavascript/EntityDisplayTest.php index 61c65769b8..73be616f60 100644 --- a/core/modules/field_ui/tests/src/FunctionalJavascript/EntityDisplayTest.php +++ b/core/modules/field_ui/tests/src/FunctionalJavascript/EntityDisplayTest.php @@ -15,7 +15,7 @@ class EntityDisplayTest extends WebDriverTestBase { /** * {@inheritdoc} */ - protected static $modules = ['field_ui', 'entity_test']; + protected static $modules = ['field_ui', 'layout_test', 'layout_discovery']; /** * {@inheritdoc} diff --git a/core/modules/forum/config/optional/core.entity_form_display.comment.comment_forum.default.yml b/core/modules/forum/config/optional/core.entity_form_display.comment.comment_forum.default.yml index 4738bbb43a..b426ba2359 100644 --- a/core/modules/forum/config/optional/core.entity_form_display.comment.comment_forum.default.yml +++ b/core/modules/forum/config/optional/core.entity_form_display.comment.comment_forum.default.yml @@ -31,3 +31,5 @@ content: placeholder: '' third_party_settings: { } hidden: { } +layout_id: layout_default +layout_settings: { } diff --git a/core/modules/forum/config/optional/core.entity_form_display.node.forum.default.yml b/core/modules/forum/config/optional/core.entity_form_display.node.forum.default.yml index 2f87d23d59..aa5a2f96bc 100644 --- a/core/modules/forum/config/optional/core.entity_form_display.node.forum.default.yml +++ b/core/modules/forum/config/optional/core.entity_form_display.node.forum.default.yml @@ -82,3 +82,5 @@ content: placeholder: '' third_party_settings: { } hidden: { } +layout_id: layout_default +layout_settings: { } diff --git a/core/modules/forum/config/optional/core.entity_form_display.taxonomy_term.forums.default.yml b/core/modules/forum/config/optional/core.entity_form_display.taxonomy_term.forums.default.yml index 51fa06906f..010adfffc8 100644 --- a/core/modules/forum/config/optional/core.entity_form_display.taxonomy_term.forums.default.yml +++ b/core/modules/forum/config/optional/core.entity_form_display.taxonomy_term.forums.default.yml @@ -34,3 +34,5 @@ content: third_party_settings: { } hidden: forum_container: true +layout_id: layout_default +layout_settings: { } diff --git a/core/modules/forum/config/optional/core.entity_view_display.comment.comment_forum.default.yml b/core/modules/forum/config/optional/core.entity_view_display.comment.comment_forum.default.yml index befeba89ae..a7fe3d8aad 100644 --- a/core/modules/forum/config/optional/core.entity_view_display.comment.comment_forum.default.yml +++ b/core/modules/forum/config/optional/core.entity_view_display.comment.comment_forum.default.yml @@ -22,3 +22,5 @@ content: weight: 100 region: content hidden: { } +layout_id: layout_default +layout_settings: { } diff --git a/core/modules/forum/config/optional/core.entity_view_display.node.forum.default.yml b/core/modules/forum/config/optional/core.entity_view_display.node.forum.default.yml index f3e8c5c613..6ff22bb817 100644 --- a/core/modules/forum/config/optional/core.entity_view_display.node.forum.default.yml +++ b/core/modules/forum/config/optional/core.entity_view_display.node.forum.default.yml @@ -44,3 +44,5 @@ content: link: true third_party_settings: { } hidden: { } +layout_id: layout_default +layout_settings: { } diff --git a/core/modules/forum/config/optional/core.entity_view_display.node.forum.teaser.yml b/core/modules/forum/config/optional/core.entity_view_display.node.forum.teaser.yml index 7b174f4429..c9bd86ddaf 100644 --- a/core/modules/forum/config/optional/core.entity_view_display.node.forum.teaser.yml +++ b/core/modules/forum/config/optional/core.entity_view_display.node.forum.teaser.yml @@ -36,3 +36,5 @@ content: third_party_settings: { } hidden: comment_forum: true +layout_id: layout_default +layout_settings: { } diff --git a/core/modules/forum/config/optional/core.entity_view_display.taxonomy_term.forums.default.yml b/core/modules/forum/config/optional/core.entity_view_display.taxonomy_term.forums.default.yml index b326039a46..4835e73b13 100644 --- a/core/modules/forum/config/optional/core.entity_view_display.taxonomy_term.forums.default.yml +++ b/core/modules/forum/config/optional/core.entity_view_display.taxonomy_term.forums.default.yml @@ -20,3 +20,5 @@ content: label: above hidden: forum_container: true +layout_id: layout_default +layout_settings: { } diff --git a/core/modules/image/tests/src/Functional/ImageFieldDefaultImagesTest.php b/core/modules/image/tests/src/Functional/ImageFieldDefaultImagesTest.php index 3e2bce273a..55b3e79d10 100644 --- a/core/modules/image/tests/src/Functional/ImageFieldDefaultImagesTest.php +++ b/core/modules/image/tests/src/Functional/ImageFieldDefaultImagesTest.php @@ -22,9 +22,7 @@ class ImageFieldDefaultImagesTest extends ImageFieldTestBase { getTestFiles as drupalGetTestFiles; compareFiles as drupalCompareFiles; } - use EntityViewTrait { - buildEntityView as drupalBuildEntityView; - } + use EntityViewTrait; /** * Modules to enable. @@ -172,7 +170,7 @@ public function testDefaultImages() { // Confirm that the image default is shown for a new article node. $article = $this->drupalCreateNode(['type' => 'article']); - $article_built = $this->drupalBuildEntityView($article); + $article_built = $this->buildFullEntityView($article); $this->assertEqual( $article_built[$field_name][0]['#item']->target_id, $default_images['field']->id(), @@ -191,7 +189,7 @@ public function testDefaultImages() { // Confirm that the image default is shown for a new page node. $page = $this->drupalCreateNode(['type' => 'page']); - $page_built = $this->drupalBuildEntityView($page); + $page_built = $this->buildFullEntityView($page); $this->assertEqual( $page_built[$field_name][0]['#item']->target_id, $default_images['field2']->id(), @@ -221,8 +219,8 @@ public function testDefaultImages() { // Reload the nodes and confirm the field defaults are used. $node_storage->resetCache([$article->id(), $page->id()]); - $article_built = $this->drupalBuildEntityView($article = $node_storage->load($article->id())); - $page_built = $this->drupalBuildEntityView($page = $node_storage->load($page->id())); + $article_built = $this->buildFullEntityView($article = $node_storage->load($article->id())); + $page_built = $this->buildFullEntityView($page = $node_storage->load($page->id())); $this->assertEqual( $article_built[$field_name][0]['#item']->target_id, $default_images['field']->id(), @@ -259,8 +257,8 @@ public function testDefaultImages() { // Reload the nodes. $node_storage->resetCache([$article->id(), $page->id()]); - $article_built = $this->drupalBuildEntityView($article = $node_storage->load($article->id())); - $page_built = $this->drupalBuildEntityView($page = $node_storage->load($page->id())); + $article_built = $this->buildFullEntityView($article = $node_storage->load($article->id())); + $page_built = $this->buildFullEntityView($page = $node_storage->load($page->id())); // Confirm the article uses the new default. $this->assertEqual( @@ -302,8 +300,8 @@ public function testDefaultImages() { // Reload the nodes. $node_storage->resetCache([$article->id(), $page->id()]); - $article_built = $this->drupalBuildEntityView($article = $node_storage->load($article->id())); - $page_built = $this->drupalBuildEntityView($page = $node_storage->load($page->id())); + $article_built = $this->buildFullEntityView($article = $node_storage->load($article->id())); + $page_built = $this->buildFullEntityView($page = $node_storage->load($page->id())); // Confirm the article uses the new field storage (not field) default. $this->assertEqual( $article_built[$field_name][0]['#item']->target_id, diff --git a/core/modules/layout_builder/src/Entity/LayoutBuilderEntityViewDisplay.php b/core/modules/layout_builder/src/Entity/LayoutBuilderEntityViewDisplay.php index 8f3b022899..6c0ca045de 100644 --- a/core/modules/layout_builder/src/Entity/LayoutBuilderEntityViewDisplay.php +++ b/core/modules/layout_builder/src/Entity/LayoutBuilderEntityViewDisplay.php @@ -232,7 +232,7 @@ public function createCopy($mode) { /** * {@inheritdoc} */ - protected function getDefaultRegion() { + public function getDefaultRegion() { if ($this->hasSection(0)) { return $this->getSection(0)->getDefaultRegion(); } @@ -280,6 +280,7 @@ public function buildMultiple(array $entities) { // field blocks by ::setComponent(). if (!Element::isEmpty($build_list[$id]['_layout_builder'])) { foreach ($build_list[$id] as $name => $build_part) { + unset($build_list[$id]['_layout']); $field_definition = $this->getFieldDefinition($name); if ($field_definition && $field_definition->isDisplayConfigurable($this->displayContext)) { unset($build_list[$id][$name]); diff --git a/core/modules/layout_discovery/layout_discovery.module b/core/modules/layout_discovery/layout_discovery.module index 3eed9fe2f9..ca31ff77ad 100644 --- a/core/modules/layout_discovery/layout_discovery.module +++ b/core/modules/layout_discovery/layout_discovery.module @@ -20,31 +20,3 @@ function layout_discovery_help($route_name) { return $output; } } - -/** - * Implements hook_theme(). - */ -function layout_discovery_theme() { - return \Drupal::service('plugin.manager.core.layout')->getThemeImplementations(); -} - -/** - * Prepares variables for layout templates. - * - * @param array &$variables - * An associative array containing: - * - content: An associative array containing the properties of the element. - * Properties used: #settings, #layout. - */ -function template_preprocess_layout(&$variables) { - $variables['settings'] = isset($variables['content']['#settings']) ? $variables['content']['#settings'] : []; - $variables['layout'] = isset($variables['content']['#layout']) ? $variables['content']['#layout'] : []; - - // Create an attributes variable for each region. - foreach (Element::children($variables['content']) as $name) { - if (!isset($variables['content'][$name]['#attributes'])) { - $variables['content'][$name]['#attributes'] = []; - } - $variables['region_attributes'][$name] = new Attribute($variables['content'][$name]['#attributes']); - } -} diff --git a/core/modules/layout_discovery/layout_discovery.services.yml b/core/modules/layout_discovery/layout_discovery.services.yml deleted file mode 100644 index 48d32292cc..0000000000 --- a/core/modules/layout_discovery/layout_discovery.services.yml +++ /dev/null @@ -1,7 +0,0 @@ -services: - plugin.manager.core.layout: - class: Drupal\Core\Layout\LayoutPluginManager - arguments: ['@container.namespaces', '@cache.discovery', '@module_handler', '@theme_handler'] - layout.icon_builder: - class: Drupal\Core\Layout\Icon\SvgIconBuilder - shared: false diff --git a/core/modules/layout_discovery/tests/src/Kernel/LayoutTest.php b/core/modules/layout_discovery/tests/src/Kernel/LayoutTest.php index c802b3ef0f..c20ac80d01 100644 --- a/core/modules/layout_discovery/tests/src/Kernel/LayoutTest.php +++ b/core/modules/layout_discovery/tests/src/Kernel/LayoutTest.php @@ -91,6 +91,17 @@ protected function render(array &$elements) { * Data provider for testRenderLayout(). */ public function renderLayoutData() { + $data['layout_default'] = [ + 'layout_default', + [], + [ + 'content' => [ + '#markup' => "This is the content\n", + ], + ], + ['This is the content'], + ]; + $html = []; $html[] = '