View source
<?php
namespace Drupal\Tests\field_ui\Kernel;
use Drupal\Component\Render\FormattableMarkup;
use Drupal\Core\Cache\Cache;
use Drupal\Core\Database\Database;
use Drupal\Core\Entity\Display\EntityDisplayInterface;
use Drupal\Core\Entity\Display\EntityViewDisplayInterface;
use Drupal\Core\Entity\Entity\EntityFormDisplay;
use Drupal\Core\Entity\Entity\EntityViewDisplay;
use Drupal\Core\Entity\Entity\EntityViewMode;
use Drupal\field\Entity\FieldConfig;
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\node\Entity\NodeType;
use Drupal\KernelTests\KernelTestBase;
use Drupal\user\Entity\Role;
class EntityDisplayTest extends KernelTestBase {
protected static $modules = [
'field_ui',
'field',
'entity_test',
'user',
'text',
'field_test',
'node',
'system',
];
protected function setUp() : void {
parent::setUp();
$this
->installEntitySchema('entity_test');
$this
->installEntitySchema('node');
$this
->installEntitySchema('user');
$this
->installConfig([
'field',
'node',
'user',
]);
}
public function testEntityDisplayCRUD() {
$display = EntityViewDisplay::create([
'targetEntityType' => 'entity_test',
'bundle' => 'entity_test',
'mode' => 'default',
]);
$expected = [];
$expected['component_1'] = [
'weight' => -4,
'settings' => [],
'third_party_settings' => [],
];
$expected['component_2'] = [
'weight' => -3,
'settings' => [],
'third_party_settings' => [],
];
$display
->setComponent('component_1');
$display
->setComponent('component_2');
$this
->assertEquals($expected['component_1'], $display
->getComponent('component_1'));
$this
->assertEquals($expected['component_2'], $display
->getComponent('component_2'));
$expected['component_3'] = [
'weight' => 10,
'third_party_settings' => [
'field_test' => [
'foo' => 'bar',
],
],
'settings' => [],
];
$display
->setComponent('component_3', $expected['component_3']);
$this
->assertEquals($expected['component_3'], $display
->getComponent('component_3'));
$display
->save();
$display = EntityViewDisplay::load($display
->id());
foreach ([
'component_1',
'component_2',
'component_3',
] as $name) {
$expected[$name]['region'] = 'content';
$this
->assertEquals($expected[$name], $display
->getComponent($name));
}
$this
->assertEquals('bar', $display
->getThirdPartySetting('entity_test', 'foo'), 'Third party settings were added to the entity view display.');
$expected['name'] = [
'label' => 'hidden',
'type' => 'string',
'weight' => -5,
'settings' => [
'link_to_entity' => FALSE,
],
'third_party_settings' => [],
'region' => 'content',
];
$this
->assertEquals($expected, $display
->getComponents());
$display
->removeComponent('component_3');
$this
->assertNULL($display
->getComponent('component_3'));
$display
->save();
$display = EntityViewDisplay::load($display
->id());
$this
->assertNULL($display
->getComponent('component_3'));
EntityViewMode::create([
'id' => $display
->getTargetEntityTypeId() . '.other_view_mode',
'targetEntityType' => $display
->getTargetEntityTypeId(),
])
->save();
$new_display = $display
->createCopy('other_view_mode');
$new_display
->save();
$new_display = EntityViewDisplay::load($new_display
->id());
$dependencies = $new_display
->calculateDependencies()
->getDependencies();
$this
->assertEquals([
'config' => [
'core.entity_view_mode.entity_test.other_view_mode',
],
'module' => [
'entity_test',
],
], $dependencies);
$this
->assertEquals($display
->getTargetEntityTypeId(), $new_display
->getTargetEntityTypeId());
$this
->assertEquals($display
->getTargetBundle(), $new_display
->getTargetBundle());
$this
->assertEquals('other_view_mode', $new_display
->getMode());
$this
->assertEquals($display
->getComponents(), $new_display
->getComponents());
}
public function testEntityDisplayCRUDSort() {
$display = EntityViewDisplay::create([
'targetEntityType' => 'entity_test',
'bundle' => 'entity_test',
'mode' => 'default',
]);
$display
->setComponent('component_3');
$display
->setComponent('component_1');
$display
->setComponent('component_2');
$display
->save();
$components = array_keys($display
->getComponents());
$expected = [
0 => 'component_1',
1 => 'component_2',
2 => 'component_3',
'name',
];
$this
->assertSame($expected, $components);
}
public function testEntityGetDisplay() {
$display_repository = $this->container
->get('entity_display.repository');
$display = $display_repository
->getViewDisplay('entity_test', 'entity_test');
$this
->assertTrue($display
->isNew());
$display
->setComponent('component_1', [
'weight' => 10,
'settings' => [],
])
->save();
$display = $display_repository
->getViewDisplay('entity_test', 'entity_test');
$this
->assertFalse($display
->isNew());
$this
->assertEquals('entity_test.entity_test.default', $display
->id());
$this
->assertEquals([
'weight' => 10,
'settings' => [],
'third_party_settings' => [],
'region' => 'content',
], $display
->getComponent('component_1'));
}
public function testExtraFieldComponent() {
entity_test_create_bundle('bundle_with_extra_fields');
$display = EntityViewDisplay::create([
'targetEntityType' => 'entity_test',
'bundle' => 'bundle_with_extra_fields',
'mode' => 'default',
]);
$this
->assertEquals([
'weight' => 5,
'region' => 'content',
'settings' => [],
'third_party_settings' => [],
], $display
->getComponent('display_extra_field'));
$this
->assertNull($display
->getComponent('display_extra_field_hidden'));
$display
->removeComponent('display_extra_field');
$display
->setComponent('display_extra_field_hidden', [
'weight' => 10,
]);
$this
->assertNull($display
->getComponent('display_extra_field'));
$this
->assertEquals([
'weight' => 10,
'settings' => [],
'third_party_settings' => [],
], $display
->getComponent('display_extra_field_hidden'));
}
public function testExtraFieldComponentInitialInvalidConfig() {
entity_test_create_bundle('bundle_with_extra_fields');
$display = EntityViewDisplay::create([
'targetEntityType' => 'entity_test',
'bundle' => 'bundle_with_extra_fields',
'mode' => 'default',
'content' => [
'display_extra_field' => [
'weight' => 5,
],
],
]);
$this
->assertEquals([
'weight' => 5,
'region' => 'content',
], $display
->getComponent('display_extra_field'));
$this
->assertNull($display
->getComponent('display_extra_field_hidden'));
$display
->removeComponent('display_extra_field');
$display
->setComponent('display_extra_field_hidden', [
'weight' => 10,
]);
$this
->assertNull($display
->getComponent('display_extra_field'));
$this
->assertEquals([
'weight' => 10,
'settings' => [],
'third_party_settings' => [],
], $display
->getComponent('display_extra_field_hidden'));
}
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();
$display = EntityViewDisplay::create([
'targetEntityType' => 'entity_test',
'bundle' => 'entity_test',
'mode' => 'default',
]);
$display
->setComponent($field_name);
$field_type_info = \Drupal::service('plugin.manager.field.field_type')
->getDefinition($field_storage
->getType());
$default_formatter = $field_type_info['default_formatter'];
$formatter_settings = \Drupal::service('plugin.manager.field.formatter')
->getDefaultSettings($default_formatter);
$expected = [
'weight' => -4,
'label' => 'above',
'type' => $default_formatter,
'settings' => $formatter_settings,
'third_party_settings' => [],
];
$this
->assertEquals($expected, $display
->getComponent($field_name));
$formatter = $display
->getRenderer($field_name);
$this
->assertEquals($default_formatter, $formatter
->getPluginId());
$this
->assertEquals($formatter_settings, $formatter
->getSettings());
$random_value = $this
->randomString();
$formatter->randomValue = $random_value;
$formatter = $display
->getRenderer($field_name);
$this
->assertEquals($random_value, $formatter->randomValue);
$display
->setComponent($field_name, [
'type' => 'field_test_multiple',
]);
$formatter = $display
->getRenderer($field_name);
$this
->assertEquals('field_test_multiple', $formatter
->getPluginId());
$this
->assertFalse(isset($formatter->randomValue));
$dependencies = $display
->calculateDependencies()
->getDependencies();
$this
->assertEquals([
'config' => [
'field.field.entity_test.entity_test.test_field',
],
'module' => [
'entity_test',
'field_test',
],
], $dependencies);
}
public function testBaseFieldComponent() {
$display = EntityViewDisplay::create([
'targetEntityType' => 'entity_test_base_field_display',
'bundle' => 'entity_test_base_field_display',
'mode' => 'default',
]);
$formatter_settings = \Drupal::service('plugin.manager.field.formatter')
->getDefaultSettings('text_default');
$expected = [
'test_no_display' => NULL,
'test_display_configurable' => [
'label' => 'above',
'type' => 'text_default',
'settings' => $formatter_settings,
'third_party_settings' => [],
'weight' => 10,
'region' => 'content',
],
'test_display_non_configurable' => [
'label' => 'above',
'type' => 'text_default',
'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_view_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 = EntityViewDisplay::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 = EntityViewDisplay::load($display
->id());
foreach ($expected as $field_name => $options) {
$this
->assertEquals($options, $display
->getComponent($field_name));
}
}
public function testDeleteBundle() {
$type = NodeType::create([
'type' => 'article',
]);
$type
->save();
node_add_body_field($type);
$display_repository = \Drupal::service('entity_display.repository');
$display_repository
->getViewDisplay('node', 'article')
->save();
$display_repository
->getFormDisplay('node', 'article')
->save();
$type
->delete();
$display = EntityViewDisplay::load('node.article.default');
$this
->assertFalse((bool) $display);
$form_display = EntityFormDisplay::load('node.article.default');
$this
->assertFalse((bool) $form_display);
}
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();
EntityViewMode::create([
'id' => 'entity_test.teaser',
'targetEntityType' => 'entity_test',
])
->save();
EntityViewDisplay::create([
'targetEntityType' => 'entity_test',
'bundle' => 'entity_test',
'mode' => 'default',
])
->setComponent($field_name)
->save();
EntityViewDisplay::create([
'targetEntityType' => 'entity_test',
'bundle' => 'entity_test',
'mode' => 'teaser',
])
->setComponent($field_name)
->save();
$display_repository = \Drupal::service('entity_display.repository');
$display = $display_repository
->getViewDisplay('entity_test', 'entity_test');
$this
->assertNotEmpty($display
->getComponent($field_name));
$display = $display_repository
->getViewDisplay('entity_test', 'entity_test', 'teaser');
$this
->assertNotEmpty($display
->getComponent($field_name));
$field
->delete();
$display = $display_repository
->getViewDisplay('entity_test', 'entity_test');
$this
->assertNull($display
->getComponent($field_name));
$display = $display_repository
->getViewDisplay('entity_test', 'entity_test', 'teaser');
$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();
EntityViewDisplay::create([
'targetEntityType' => 'entity_test',
'bundle' => 'entity_test',
'mode' => 'default',
])
->setComponent($field_name, [
'type' => 'field_plugins_test_text_formatter',
])
->save();
$display_repository = \Drupal::service('entity_display.repository');
$display = $display_repository
->getViewDisplay('entity_test', 'entity_test');
$this
->assertEquals('field_plugins_test_text_formatter', $display
->getComponent($field_name)['type']);
\Drupal::service('config.manager')
->uninstall('module', 'field_plugins_test');
$display = $display_repository
->getViewDisplay('entity_test', 'entity_test');
$this
->assertEquals('text_default', $display
->getComponent($field_name)['type']);
\Drupal::service('config.manager')
->uninstall('module', 'text');
$display = $display_repository
->getViewDisplay('entity_test', 'entity_test');
$this
->assertNull($display
->getComponent($field_name));
}
public function testEntityDisplayInvalidateCacheTags() {
$cache = \Drupal::cache();
$cache
->set('cid', 'kittens', Cache::PERMANENT, [
'config:entity_view_display_list',
]);
$display = EntityViewDisplay::create([
'targetEntityType' => 'entity_test',
'bundle' => 'entity_test',
'mode' => 'default',
]);
$display
->setComponent('kitten');
$display
->save();
$this
->assertFalse($cache
->get('cid'));
}
public function testGetDisplayModeOptions() {
NodeType::create([
'type' => 'article',
])
->save();
EntityViewDisplay::create([
'targetEntityType' => 'node',
'bundle' => 'article',
'mode' => 'default',
])
->setStatus(TRUE)
->save();
$display_teaser = EntityViewDisplay::create([
'targetEntityType' => 'node',
'bundle' => 'article',
'mode' => 'teaser',
]);
$display_teaser
->save();
EntityFormDisplay::create([
'targetEntityType' => 'user',
'bundle' => 'user',
'mode' => 'default',
])
->setStatus(TRUE)
->save();
$form_display_teaser = EntityFormDisplay::create([
'targetEntityType' => 'user',
'bundle' => 'user',
'mode' => 'register',
]);
$form_display_teaser
->save();
$view_modes = \Drupal::service('entity_display.repository')
->getViewModeOptionsByBundle('node', 'article');
$this
->assertEquals([
'default' => 'Default',
], $view_modes);
$display_teaser
->setStatus(TRUE)
->save();
$view_modes = \Drupal::service('entity_display.repository')
->getViewModeOptionsByBundle('node', 'article');
$this
->assertEquals([
'default' => 'Default',
'teaser' => 'Teaser',
], $view_modes);
$form_modes = \Drupal::service('entity_display.repository')
->getFormModeOptionsByBundle('user', 'user');
$this
->assertEquals([
'default' => 'Default',
], $form_modes);
$form_display_teaser
->setStatus(TRUE)
->save();
$form_modes = \Drupal::service('entity_display.repository')
->getFormModeOptionsByBundle('user', 'user');
$this
->assertEquals([
'default' => 'Default',
'register' => 'Register',
], $form_modes);
}
public function testComponentDependencies() {
$this
->enableModules([
'dblog',
'help',
]);
$this
->installSchema('dblog', [
'watchdog',
]);
$this
->installEntitySchema('user');
$roles = [];
for ($i = 0; $i < 2; $i++) {
$roles[$i] = Role::create([
'id' => mb_strtolower($this
->randomMachineName()),
'label' => $this
->randomString(),
]);
$roles[$i]
->save();
}
$field_name = mb_strtolower($this
->randomMachineName());
FieldStorageConfig::create([
'field_name' => $field_name,
'entity_type' => 'entity_test',
'type' => 'test_field',
])
->save();
FieldConfig::create([
'field_name' => $field_name,
'entity_type' => 'entity_test',
'bundle' => 'entity_test',
])
->save();
$form_display = EntityFormDisplay::create([
'targetEntityType' => 'entity_test',
'bundle' => 'entity_test',
'mode' => 'default',
]);
$form_display
->save();
$dependencies = [
'user.role.' . $roles[0]
->id(),
'user.role.' . $roles[1]
->id(),
];
$this
->assertNoDependency('config', $dependencies[0], $form_display);
$this
->assertNoDependency('config', $dependencies[1], $form_display);
$component = [
'type' => 'test_field_widget',
'settings' => [
'test_widget_setting' => $this
->randomString(),
'role' => $roles[0]
->id(),
'role2' => $roles[1]
->id(),
],
'third_party_settings' => [
'help' => [
'foo' => 'bar',
],
],
];
$form_display
->setComponent($field_name, $component);
$form_display
->save();
$this
->assertDependency('config', $dependencies[0], $form_display);
$this
->assertDependency('config', $dependencies[1], $form_display);
$this
->assertDependency('module', 'help', $form_display);
$roles[0]
->delete();
$form_display = EntityFormDisplay::load($form_display
->id());
$this
->assertNotEmpty($form_display);
$this
->assertNoDependency('config', $dependencies[0], $form_display);
$this
->assertDependency('config', 'user.role.anonymous', $form_display);
$this
->assertDependency('module', 'help', $form_display);
$this->container
->get('config.manager')
->uninstall('module', 'help');
$this
->disableModules([
'help',
]);
$form_display = EntityFormDisplay::load($form_display
->id());
$this
->assertNotEmpty($form_display);
$this
->assertNotNull($form_display
->getComponent($field_name));
$this
->assertNoDependency('module', 'help', $form_display);
$roles[1]
->delete();
$form_display = EntityFormDisplay::load($form_display
->id());
$this
->assertNotEmpty($form_display);
$this
->assertNull($form_display
->getComponent($field_name));
$this
->assertTrue($form_display
->get('hidden')[$field_name]);
$arguments = [
'@display' => 'Entity form display',
'@id' => $form_display
->id(),
'@name' => $field_name,
];
$variables = Database::getConnection()
->select('watchdog', 'w')
->fields('w', [
'variables',
])
->condition('type', 'system')
->condition('message', "@display '@id': Component '@name' was disabled because its settings depend on removed dependencies.")
->execute()
->fetchField();
$this
->assertEquals($arguments, unserialize($variables));
}
protected function assertDependency(string $type, string $key, EntityDisplayInterface $display) : void {
$this
->assertDependencyHelper(TRUE, $type, $key, $display);
}
protected function assertNoDependency(string $type, string $key, EntityDisplayInterface $display) : void {
$this
->assertDependencyHelper(FALSE, $type, $key, $display);
}
protected function assertDependencyHelper(bool $assertion, string $type, string $key, EntityDisplayInterface $display) : void {
$all_dependencies = $display
->getDependencies();
$dependencies = !empty($all_dependencies[$type]) ? $all_dependencies[$type] : [];
$context = $display instanceof EntityViewDisplayInterface ? 'View' : 'Form';
$value = $assertion ? in_array($key, $dependencies) : !in_array($key, $dependencies);
$args = [
'@context' => $context,
'@id' => $display
->id(),
'@type' => $type,
'@key' => $key,
];
$message = $assertion ? new FormattableMarkup("@context display '@id' depends on @type '@key'.", $args) : new FormattableMarkup("@context display '@id' do not depend on @type '@key'.", $args);
$this
->assertTrue($value, $message);
}
}