View source
<?php
namespace Drupal\Tests\field_ui\Kernel;
use Drupal\Core\Entity\Entity\EntityFormDisplay;
use Drupal\Core\Entity\Entity\EntityFormMode;
use Drupal\field\Entity\FieldConfig;
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\KernelTests\KernelTestBase;
class EntityFormDisplayTest extends KernelTestBase {
protected static $modules = [
'field_ui',
'field',
'entity_test',
'field_test',
'user',
'text',
];
protected function setUp() : void {
parent::setUp();
$this
->installEntitySchema('entity_test');
}
public function testEntityGetFromDisplay() {
$display_repository = \Drupal::service('entity_display.repository');
$form_display = $display_repository
->getFormDisplay('entity_test', 'entity_test');
$this
->assertTrue($form_display
->isNew());
$form_display
->setComponent('component_1', [
'weight' => 10,
])
->save();
$form_display = $display_repository
->getFormDisplay('entity_test', 'entity_test');
$this
->assertFalse($form_display
->isNew());
$this
->assertEquals('entity_test.entity_test.default', $form_display
->id());
$this
->assertEquals([
'weight' => 10,
'settings' => [],
'third_party_settings' => [],
'region' => 'content',
], $form_display
->getComponent('component_1'));
}
public function testFieldComponent() {
$field_name = 'test_field';
$field_storage = FieldStorageConfig::create([
'field_name' => $field_name,
'entity_type' => 'entity_test',
'type' => 'test_field',
]);
$field_storage
->save();
$field = FieldConfig::create([
'field_storage' => $field_storage,
'bundle' => 'entity_test',
]);
$field
->save();
$form_display = EntityFormDisplay::create([
'targetEntityType' => 'entity_test',
'bundle' => 'entity_test',
'mode' => 'default',
]);
$form_display
->setComponent($field_name);
$field_type_info = \Drupal::service('plugin.manager.field.field_type')
->getDefinition($field_storage
->getType());
$default_widget = $field_type_info['default_widget'];
$widget_settings = \Drupal::service('plugin.manager.field.widget')
->getDefaultSettings($default_widget);
$expected = [
'weight' => 3,
'type' => $default_widget,
'settings' => $widget_settings,
'third_party_settings' => [],
];
$this
->assertEquals($expected, $form_display
->getComponent($field_name));
$widget = $form_display
->getRenderer($field_name);
$this
->assertEquals($default_widget, $widget
->getPluginId());
$this
->assertEquals($widget_settings, $widget
->getSettings());
$random_value = $this
->randomString();
$widget->randomValue = $random_value;
$widget = $form_display
->getRenderer($field_name);
$this
->assertEquals($random_value, $widget->randomValue);
$form_display
->setComponent($field_name, [
'type' => 'field_test_multiple',
]);
$widget = $form_display
->getRenderer($field_name);
$this
->assertEquals('test_field_widget', $widget
->getPluginId());
$this
->assertFalse(isset($widget->randomValue));
$form_display
->setComponent($field_name, [
'type' => 'unknown_widget',
]);
$options = $form_display
->getComponent($field_name);
$this
->assertEquals('unknown_widget', $options['type']);
$widget = $form_display
->getRenderer($field_name);
$this
->assertEquals($default_widget, $widget
->getPluginId());
}
public function testBaseFieldComponent() {
$display = EntityFormDisplay::create([
'targetEntityType' => 'entity_test_base_field_display',
'bundle' => 'entity_test_base_field_display',
'mode' => 'default',
]);
$formatter_settings = \Drupal::service('plugin.manager.field.widget')
->getDefaultSettings('text_textfield');
$expected = [
'test_no_display' => NULL,
'test_display_configurable' => [
'type' => 'text_textfield',
'settings' => $formatter_settings,
'third_party_settings' => [],
'weight' => 10,
'region' => 'content',
],
'test_display_non_configurable' => [
'type' => 'text_textfield',
'settings' => $formatter_settings,
'third_party_settings' => [],
'weight' => 11,
'region' => 'content',
],
];
foreach ($expected as $field_name => $options) {
$this
->assertEquals($options, $display
->getComponent($field_name));
}
$display
->save();
$config = $this
->config('core.entity_form_display.' . $display
->id());
$data = $config
->get();
$this
->assertFalse(isset($data['content']['test_no_display']));
$this
->assertFalse(isset($data['hidden']['test_no_display']));
$this
->assertEquals($expected['test_display_configurable'], $data['content']['test_display_configurable']);
$this
->assertFalse(isset($data['content']['test_display_non_configurable']));
$this
->assertFalse(isset($data['hidden']['test_display_non_configurable']));
$display = EntityFormDisplay::load($display
->id());
foreach ($expected as $field_name => $options) {
$this
->assertEquals($options, $display
->getComponent($field_name));
}
$data['content']['test_display_non_configurable'] = $expected['test_display_non_configurable'];
$data['content']['test_display_non_configurable']['weight']++;
$config
->setData($data)
->save();
$display = EntityFormDisplay::load($display
->id());
foreach ($expected as $field_name => $options) {
$this
->assertEquals($options, $display
->getComponent($field_name));
}
}
public function testDeleteField() {
$field_name = 'test_field';
$field_storage = FieldStorageConfig::create([
'field_name' => $field_name,
'entity_type' => 'entity_test',
'type' => 'test_field',
]);
$field_storage
->save();
$field = FieldConfig::create([
'field_storage' => $field_storage,
'bundle' => 'entity_test',
]);
$field
->save();
EntityFormMode::create([
'id' => 'entity_test.compact',
'targetEntityType' => 'entity_test',
])
->save();
EntityFormDisplay::create([
'targetEntityType' => 'entity_test',
'bundle' => 'entity_test',
'mode' => 'default',
])
->setComponent($field_name)
->save();
EntityFormDisplay::create([
'targetEntityType' => 'entity_test',
'bundle' => 'entity_test',
'mode' => 'compact',
])
->setComponent($field_name)
->save();
$display_repository = \Drupal::service('entity_display.repository');
$display = $display_repository
->getFormDisplay('entity_test', 'entity_test');
$this
->assertNotEmpty($display
->getComponent($field_name));
$display = $display_repository
->getFormDisplay('entity_test', 'entity_test', 'compact');
$this
->assertNotEmpty($display
->getComponent($field_name));
$field
->delete();
$display = $display_repository
->getFormDisplay('entity_test', 'entity_test');
$this
->assertNull($display
->getComponent($field_name));
$display = $display_repository
->getFormDisplay('entity_test', 'entity_test', 'compact');
$this
->assertNull($display
->getComponent($field_name));
}
public function testOnDependencyRemoval() {
$this
->enableModules([
'field_plugins_test',
]);
$field_name = 'test_field';
$field_storage = FieldStorageConfig::create([
'field_name' => $field_name,
'entity_type' => 'entity_test',
'type' => 'text',
]);
$field_storage
->save();
$field = FieldConfig::create([
'field_storage' => $field_storage,
'bundle' => 'entity_test',
]);
$field
->save();
EntityFormDisplay::create([
'targetEntityType' => 'entity_test',
'bundle' => 'entity_test',
'mode' => 'default',
])
->setComponent($field_name, [
'type' => 'field_plugins_test_text_widget',
])
->save();
$display_repository = \Drupal::service('entity_display.repository');
$display = $display_repository
->getFormDisplay('entity_test', 'entity_test');
$this
->assertEquals('field_plugins_test_text_widget', $display
->getComponent($field_name)['type']);
\Drupal::service('config.manager')
->uninstall('module', 'field_plugins_test');
$display = $display_repository
->getFormDisplay('entity_test', 'entity_test');
$this
->assertEquals('text_textfield', $display
->getComponent($field_name)['type']);
\Drupal::service('config.manager')
->uninstall('module', 'text');
$display = $display_repository
->getFormDisplay('entity_test', 'entity_test');
$this
->assertNull($display
->getComponent($field_name));
}
}