www.aleph1.co.uk Git - yaffs-website/blob - web/core/modules/layout_builder/tests/src/Kernel/LayoutBuilderInstallTest.php

   1 <?php
   2
   3 namespace Drupal\Tests\layout_builder\Kernel;
   4
   5 use Drupal\field\Entity\FieldConfig;
   6 use Drupal\field\Entity\FieldStorageConfig;
   7 use Drupal\layout_builder\Section;
   8
   9 /**
  10  * Ensures that Layout Builder and core EntityViewDisplays are compatible.
  11  *
  12  * @group layout_builder
  13  */
  14 class LayoutBuilderInstallTest extends LayoutBuilderCompatibilityTestBase {
  15
  16   /**
  17    * Tests the compatibility of Layout Builder with existing entity displays.
  18    */
  19   public function testCompatibility() {
  20     // Ensure that the fields are shown.
  21     $expected_fields = [
  22       'field field--name-name field--type-string field--label-hidden field__item',
  23       'field field--name-test-field-display-configurable field--type-boolean field--label-above',
  24       'clearfix text-formatted field field--name-test-display-configurable field--type-text field--label-above',
  25       'clearfix text-formatted field field--name-test-display-non-configurable field--type-text field--label-above',
  26       'clearfix text-formatted field field--name-test-display-multiple field--type-text field--label-above',
  27     ];
  28     $this->assertFieldAttributes($this->entity, $expected_fields);
  29
  30     $this->installLayoutBuilder();
  31
  32     // Without using Layout Builder for an override, the result has not changed.
  33     $this->assertFieldAttributes($this->entity, $expected_fields);
  34
  35     // Add a layout override.
  36     $this->enableOverrides();
  37     $this->entity = $this->reloadEntity($this->entity);
  38     $this->entity->get('layout_builder__layout')->appendSection(new Section('layout_onecol'));
  39     $this->entity->save();
  40
  41     // The rendered entity has now changed. The non-configurable field is shown
  42     // outside the layout, the configurable field is not shown at all, and the
  43     // layout itself is rendered (but empty).
  44     $new_expected_fields = [
  45       'field field--name-name field--type-string field--label-hidden field__item',
  46       'clearfix text-formatted field field--name-test-display-non-configurable field--type-text field--label-above',
  47       'clearfix text-formatted field field--name-test-display-multiple field--type-text field--label-above',
  48     ];
  49     $this->assertFieldAttributes($this->entity, $new_expected_fields);
  50     $this->assertNotEmpty($this->cssSelect('.layout--onecol'));
  51
  52     // Removing the layout restores the original rendering of the entity.
  53     $this->entity->get('layout_builder__layout')->removeSection(0);
  54     $this->entity->save();
  55     $this->assertFieldAttributes($this->entity, $expected_fields);
  56
  57     // Test that adding a new field after Layout Builder has been installed will
  58     // add the new field to the default region of the first section.
  59     $field_storage = FieldStorageConfig::create([
  60       'entity_type' => 'entity_test_base_field_display',
  61       'field_name' => 'test_field_display_post_install',
  62       'type' => 'text',
  63     ]);
  64     $field_storage->save();
  65     FieldConfig::create([
  66       'field_storage' => $field_storage,
  67       'bundle' => 'entity_test_base_field_display',
  68       'label' => 'FieldConfig with configurable display',
  69     ])->save();
  70
  71     $this->entity = $this->reloadEntity($this->entity);
  72     $this->entity->test_field_display_post_install = 'Test string';
  73     $this->entity->save();
  74
  75     $this->display = $this->reloadEntity($this->display);
  76     $this->display
  77       ->setComponent('test_field_display_post_install', ['weight' => 50])
  78       ->save();
  79     $new_expected_fields = [
  80       'field field--name-name field--type-string field--label-hidden field__item',
  81       'field field--name-test-field-display-configurable field--type-boolean field--label-above',
  82       'clearfix text-formatted field field--name-test-display-configurable field--type-text field--label-above',
  83       'clearfix text-formatted field field--name-test-field-display-post-install field--type-text field--label-above',
  84       'clearfix text-formatted field field--name-test-display-non-configurable field--type-text field--label-above',
  85       'clearfix text-formatted field field--name-test-display-multiple field--type-text field--label-above',
  86     ];
  87     $this->assertFieldAttributes($this->entity, $new_expected_fields);
  88     $this->assertNotEmpty($this->cssSelect('.layout--onecol'));
  89     $this->assertText('Test string');
  90   }
  91
  92 }