class EntityDisplayTest
Same name in this branch
- 8.9.x core/modules/field_ui/tests/src/FunctionalJavascript/EntityDisplayTest.php \Drupal\Tests\field_ui\FunctionalJavascript\EntityDisplayTest
- 8.9.x core/modules/field_ui/tests/src/Functional/EntityDisplayTest.php \Drupal\Tests\field_ui\Functional\EntityDisplayTest
Same name in other branches
- 9 core/modules/field_ui/tests/src/FunctionalJavascript/EntityDisplayTest.php \Drupal\Tests\field_ui\FunctionalJavascript\EntityDisplayTest
- 9 core/modules/field_ui/tests/src/Kernel/EntityDisplayTest.php \Drupal\Tests\field_ui\Kernel\EntityDisplayTest
- 9 core/modules/field_ui/tests/src/Functional/EntityDisplayTest.php \Drupal\Tests\field_ui\Functional\EntityDisplayTest
- 10 core/modules/field_ui/tests/src/FunctionalJavascript/EntityDisplayTest.php \Drupal\Tests\field_ui\FunctionalJavascript\EntityDisplayTest
- 10 core/modules/field_ui/tests/src/Kernel/EntityDisplayTest.php \Drupal\Tests\field_ui\Kernel\EntityDisplayTest
- 10 core/modules/field_ui/tests/src/Functional/EntityDisplayTest.php \Drupal\Tests\field_ui\Functional\EntityDisplayTest
- 11.x core/modules/field_ui/tests/src/FunctionalJavascript/EntityDisplayTest.php \Drupal\Tests\field_ui\FunctionalJavascript\EntityDisplayTest
- 11.x core/modules/field_ui/tests/src/Kernel/EntityDisplayTest.php \Drupal\Tests\field_ui\Kernel\EntityDisplayTest
- 11.x core/modules/field_ui/tests/src/Functional/EntityDisplayTest.php \Drupal\Tests\field_ui\Functional\EntityDisplayTest
Tests the entity display configuration entities.
@group field_ui
Hierarchy
- class \Drupal\KernelTests\KernelTestBase extends \PHPUnit\Framework\TestCase implements \Drupal\Core\DependencyInjection\ServiceProviderInterface uses \Drupal\KernelTests\AssertLegacyTrait, \Drupal\KernelTests\AssertContentTrait, \Drupal\Tests\AssertHelperTrait, \Drupal\Tests\RandomGeneratorTrait, \Drupal\Tests\ConfigTestTrait, \Drupal\Tests\TestRequirementsTrait, \Drupal\Tests\PhpunitCompatibilityTrait
- class \Drupal\Tests\field_ui\Kernel\EntityDisplayTest extends \Drupal\KernelTests\KernelTestBase
Expanded class hierarchy of EntityDisplayTest
File
-
core/
modules/ field_ui/ tests/ src/ Kernel/ EntityDisplayTest.php, line 24
Namespace
Drupal\Tests\field_ui\KernelView source
class EntityDisplayTest extends KernelTestBase {
/**
* Modules to install.
*
* @var string[]
*/
public static $modules = [
'field_ui',
'field',
'entity_test',
'user',
'text',
'field_test',
'node',
'system',
];
protected function setUp() {
parent::setUp();
$this->installEntitySchema('entity_test');
$this->installEntitySchema('node');
$this->installEntitySchema('user');
$this->installConfig([
'field',
'node',
'user',
]);
}
/**
* Tests basic CRUD operations on entity display objects.
*/
public function testEntityDisplayCRUD() {
$display = EntityViewDisplay::create([
'targetEntityType' => 'entity_test',
'bundle' => 'entity_test',
'mode' => 'default',
]);
$expected = [];
// Check that providing no 'weight' results in the highest current weight
// being assigned. The 'name' field's formatter has weight -5, therefore
// these follow.
$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->assertEqual($display->getComponent('component_1'), $expected['component_1']);
$this->assertEqual($display->getComponent('component_2'), $expected['component_2']);
// Check that arbitrary options are correctly stored.
$expected['component_3'] = [
'weight' => 10,
'third_party_settings' => [
'field_test' => [
'foo' => 'bar',
],
],
'settings' => [],
];
$display->setComponent('component_3', $expected['component_3']);
$this->assertEqual($display->getComponent('component_3'), $expected['component_3']);
// Check that the display can be properly saved and read back.
$display->save();
$display = EntityViewDisplay::load($display->id());
foreach ([
'component_1',
'component_2',
'component_3',
] as $name) {
$expected[$name]['region'] = 'content';
$this->assertEqual($display->getComponent($name), $expected[$name]);
}
// Ensure that third party settings were added to the config entity.
// These are added by entity_test_entity_presave() implemented in
// entity_test module.
$this->assertEqual('bar', $display->getThirdPartySetting('entity_test', 'foo'), 'Third party settings were added to the entity view display.');
// Check that getComponents() returns options for all components.
$expected['name'] = [
'label' => 'hidden',
'type' => 'string',
'weight' => -5,
'settings' => [
'link_to_entity' => FALSE,
],
'third_party_settings' => [],
'region' => 'content',
];
$this->assertEqual($display->getComponents(), $expected);
// Check that a component can be removed.
$display->removeComponent('component_3');
$this->assertNULL($display->getComponent('component_3'));
// Check that the removal is correctly persisted.
$display->save();
$display = EntityViewDisplay::load($display->id());
$this->assertNULL($display->getComponent('component_3'));
// Check that createCopy() creates a new component that can be correctly
// saved.
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->assertEqual([
'config' => [
'core.entity_view_mode.entity_test.other_view_mode',
],
'module' => [
'entity_test',
],
], $dependencies);
$this->assertEqual($new_display->getTargetEntityTypeId(), $display->getTargetEntityTypeId());
$this->assertEqual($new_display->getTargetBundle(), $display->getTargetBundle());
$this->assertEqual($new_display->getMode(), 'other_view_mode');
$this->assertEqual($new_display->getComponents(), $display->getComponents());
}
/**
* Test sorting of components by name on basic CRUD operations
*/
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());
// The name field is not configurable so will be added automatically.
$expected = [
0 => 'component_1',
1 => 'component_2',
2 => 'component_3',
'name',
];
$this->assertIdentical($components, $expected);
}
/**
* @covers \Drupal\Core\Entity\EntityDisplayRepository::getViewDisplay
*/
public function testEntityGetDisplay() {
$display_repository = $this->container
->get('entity_display.repository');
// Check that getViewDisplay() returns a fresh object when no configuration
// entry exists.
$display = $display_repository->getViewDisplay('entity_test', 'entity_test');
$this->assertTrue($display->isNew());
// Add some components and save the display.
$display->setComponent('component_1', [
'weight' => 10,
'settings' => [],
])
->save();
// Check that getViewDisplay() returns the correct object.
$display = $display_repository->getViewDisplay('entity_test', 'entity_test');
$this->assertFalse($display->isNew());
$this->assertEqual($display->id(), 'entity_test.entity_test.default');
$this->assertEqual($display->getComponent('component_1'), [
'weight' => 10,
'settings' => [],
'third_party_settings' => [],
'region' => 'content',
]);
}
/**
* Tests the behavior of a field component within an entity display object.
*/
public function testExtraFieldComponent() {
entity_test_create_bundle('bundle_with_extra_fields');
$display = EntityViewDisplay::create([
'targetEntityType' => 'entity_test',
'bundle' => 'bundle_with_extra_fields',
'mode' => 'default',
]);
// Check that the default visibility taken into account for extra fields
// unknown in the display.
$this->assertEqual($display->getComponent('display_extra_field'), [
'weight' => 5,
'region' => 'content',
'settings' => [],
'third_party_settings' => [],
]);
$this->assertNull($display->getComponent('display_extra_field_hidden'));
// Check that setting explicit options overrides the defaults.
$display->removeComponent('display_extra_field');
$display->setComponent('display_extra_field_hidden', [
'weight' => 10,
]);
$this->assertNull($display->getComponent('display_extra_field'));
$this->assertEqual($display->getComponent('display_extra_field_hidden'), [
'weight' => 10,
'settings' => [],
'third_party_settings' => [],
]);
}
/**
* Tests the behavior of an extra field component with initial invalid values.
*/
public function testExtraFieldComponentInitialInvalidConfig() {
entity_test_create_bundle('bundle_with_extra_fields');
$display = EntityViewDisplay::create([
'targetEntityType' => 'entity_test',
'bundle' => 'bundle_with_extra_fields',
'mode' => 'default',
// Add the extra field to the initial config, without a 'type'.
'content' => [
'display_extra_field' => [
'weight' => 5,
],
],
]);
// Check that the default visibility taken into account for extra fields
// unknown in the display that were included in the initial config.
$this->assertEqual($display->getComponent('display_extra_field'), [
'weight' => 5,
'region' => 'content',
]);
$this->assertNull($display->getComponent('display_extra_field_hidden'));
// Check that setting explicit options overrides the defaults.
$display->removeComponent('display_extra_field');
$display->setComponent('display_extra_field_hidden', [
'weight' => 10,
]);
$this->assertNull($display->getComponent('display_extra_field'));
$this->assertEqual($display->getComponent('display_extra_field_hidden'), [
'weight' => 10,
'settings' => [],
'third_party_settings' => [],
]);
}
/**
* Tests the behavior of a field component within an entity display object.
*/
public function testFieldComponent() {
$field_name = 'test_field';
// Create a field storage and a 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',
]);
// Check that providing no options results in default values being used.
$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->assertEqual($display->getComponent($field_name), $expected);
// Check that the getFormatter() method returns the correct formatter plugin.
$formatter = $display->getRenderer($field_name);
$this->assertEqual($formatter->getPluginId(), $default_formatter);
$this->assertEqual($formatter->getSettings(), $formatter_settings);
// Check that the formatter is statically persisted, by assigning an
// arbitrary property and reading it back.
$random_value = $this->randomString();
$formatter->randomValue = $random_value;
$formatter = $display->getRenderer($field_name);
$this->assertEqual($formatter->randomValue, $random_value);
// Check that changing the definition creates a new formatter.
$display->setComponent($field_name, [
'type' => 'field_test_multiple',
]);
$formatter = $display->getRenderer($field_name);
$this->assertEqual($formatter->getPluginId(), 'field_test_multiple');
$this->assertFalse(isset($formatter->randomValue));
// Check that the display has dependencies on the field and the module that
// provides the formatter.
$dependencies = $display->calculateDependencies()
->getDependencies();
$this->assertEqual([
'config' => [
'field.field.entity_test.entity_test.test_field',
],
'module' => [
'entity_test',
'field_test',
],
], $dependencies);
}
/**
* Tests the behavior of a field component for a base field.
*/
public function testBaseFieldComponent() {
$display = EntityViewDisplay::create([
'targetEntityType' => 'entity_test_base_field_display',
'bundle' => 'entity_test_base_field_display',
'mode' => 'default',
]);
// Check that default options are correctly filled in.
$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->assertEqual($display->getComponent($field_name), $options);
}
// Check that saving the display only writes data for fields whose display
// is configurable.
$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->assertEqual($data['content']['test_display_configurable'], $expected['test_display_configurable']);
$this->assertFalse(isset($data['content']['test_display_non_configurable']));
$this->assertFalse(isset($data['hidden']['test_display_non_configurable']));
// Check that defaults are correctly filled when loading the display.
$display = EntityViewDisplay::load($display->id());
foreach ($expected as $field_name => $options) {
$this->assertEqual($display->getComponent($field_name), $options);
}
// Check that data manually written for fields whose display is not
// configurable is discarded when loading the display.
$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->assertEqual($display->getComponent($field_name), $options);
}
}
/**
* Tests deleting a bundle.
*/
public function testDeleteBundle() {
// Create a node bundle, display and form display object.
$type = NodeType::create([
'type' => 'article',
]);
$type->save();
node_add_body_field($type);
/** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */
$display_repository = \Drupal::service('entity_display.repository');
$display_repository->getViewDisplay('node', 'article')
->save();
$display_repository->getFormDisplay('node', 'article')
->save();
// Delete the bundle.
$type->delete();
$display = EntityViewDisplay::load('node.article.default');
$this->assertFalse((bool) $display);
$form_display = EntityFormDisplay::load('node.article.default');
$this->assertFalse((bool) $form_display);
}
/**
* Tests deleting field.
*/
public function testDeleteField() {
$field_name = 'test_field';
// Create a field storage and a 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();
// Create default and teaser entity display.
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();
/** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */
$display_repository = \Drupal::service('entity_display.repository');
// Check the component exists.
$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));
// Delete the field.
$field->delete();
// Check that the component has been removed from the entity displays.
$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));
}
/**
* Tests \Drupal\Core\Entity\EntityDisplayBase::onDependencyRemoval().
*/
public function testOnDependencyRemoval() {
$this->enableModules([
'field_plugins_test',
]);
$field_name = 'test_field';
// Create a 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();
/** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */
$display_repository = \Drupal::service('entity_display.repository');
// Check the component exists and is of the correct type.
$display = $display_repository->getViewDisplay('entity_test', 'entity_test');
$this->assertEqual($display->getComponent($field_name)['type'], 'field_plugins_test_text_formatter');
// Removing the field_plugins_test module should change the component to use
// the default formatter for test fields.
\Drupal::service('config.manager')->uninstall('module', 'field_plugins_test');
$display = $display_repository->getViewDisplay('entity_test', 'entity_test');
$this->assertEqual($display->getComponent($field_name)['type'], 'text_default');
// Removing the text module should remove the field from the view display.
\Drupal::service('config.manager')->uninstall('module', 'text');
$display = $display_repository->getViewDisplay('entity_test', 'entity_test');
$this->assertNull($display->getComponent($field_name));
}
/**
* Ensure that entity view display changes invalidates cache tags.
*/
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'));
}
/**
* Test getDisplayModeOptions().
*/
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();
// Test getViewModeOptionsByBundle().
$view_modes = \Drupal::service('entity_display.repository')->getViewModeOptionsByBundle('node', 'article');
$this->assertEqual($view_modes, [
'default' => 'Default',
]);
$display_teaser->setStatus(TRUE)
->save();
$view_modes = \Drupal::service('entity_display.repository')->getViewModeOptionsByBundle('node', 'article');
$this->assertEqual($view_modes, [
'default' => 'Default',
'teaser' => 'Teaser',
]);
// Test getFormModeOptionsByBundle().
$form_modes = \Drupal::service('entity_display.repository')->getFormModeOptionsByBundle('user', 'user');
$this->assertEqual($form_modes, [
'default' => 'Default',
]);
$form_display_teaser->setStatus(TRUE)
->save();
$form_modes = \Drupal::service('entity_display.repository')->getFormModeOptionsByBundle('user', 'user');
$this->assertEqual($form_modes, [
'default' => 'Default',
'register' => 'Register',
]);
}
/**
* Tests components dependencies additions.
*/
public function testComponentDependencies() {
$this->enableModules([
'dblog',
'color',
]);
$this->installSchema('dblog', [
'watchdog',
]);
$this->installEntitySchema('user');
/** @var \Drupal\user\RoleInterface[] $roles */
$roles = [];
// Create two arbitrary user roles.
for ($i = 0; $i < 2; $i++) {
$roles[$i] = Role::create([
'id' => mb_strtolower($this->randomMachineName()),
'label' => $this->randomString(),
]);
$roles[$i]->save();
}
// Create a field of type 'test_field' attached to 'entity_test'.
$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();
// Create a new form display without components.
/** @var \Drupal\Core\Entity\Display\EntityFormDisplayInterface $form_display */
$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(),
];
// The config object should not depend on none of the two $roles.
$this->assertNoDependency('config', $dependencies[0], $form_display);
$this->assertNoDependency('config', $dependencies[1], $form_display);
// Add a widget of type 'test_field_widget'.
$component = [
'type' => 'test_field_widget',
'settings' => [
'test_widget_setting' => $this->randomString(),
'role' => $roles[0]->id(),
'role2' => $roles[1]->id(),
],
'third_party_settings' => [
'color' => [
'foo' => 'bar',
],
],
];
$form_display->setComponent($field_name, $component);
$form_display->save();
// Now, the form display should depend on both user roles $roles.
$this->assertDependency('config', $dependencies[0], $form_display);
$this->assertDependency('config', $dependencies[1], $form_display);
// The form display should depend on 'color' module.
$this->assertDependency('module', 'color', $form_display);
// Delete the first user role entity.
$roles[0]->delete();
// Reload the form display.
$form_display = EntityFormDisplay::load($form_display->id());
// The display exists.
$this->assertFalse(empty($form_display));
// The form display should not depend on $role[0] anymore.
$this->assertNoDependency('config', $dependencies[0], $form_display);
// The form display should depend on 'anonymous' user role.
$this->assertDependency('config', 'user.role.anonymous', $form_display);
// The form display should depend on 'color' module.
$this->assertDependency('module', 'color', $form_display);
// Manually trigger the removal of configuration belonging to the module
// because KernelTestBase::disableModules() is not aware of this.
$this->container
->get('config.manager')
->uninstall('module', 'color');
// Uninstall 'color' module.
$this->disableModules([
'color',
]);
// Reload the form display.
$form_display = EntityFormDisplay::load($form_display->id());
// The display exists.
$this->assertFalse(empty($form_display));
// The component is still enabled.
$this->assertNotNull($form_display->getComponent($field_name));
// The form display should not depend on 'color' module anymore.
$this->assertNoDependency('module', 'color', $form_display);
// Delete the 2nd user role entity.
$roles[1]->delete();
// Reload the form display.
$form_display = EntityFormDisplay::load($form_display->id());
// The display exists.
$this->assertFalse(empty($form_display));
// The component has been disabled.
$this->assertNull($form_display->getComponent($field_name));
$this->assertTrue($form_display->get('hidden')[$field_name]);
// The correct warning message has been logged.
$arguments = [
'@display' => (string) t('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));
}
/**
* Asserts that $key is a $type type dependency of $display config entity.
*
* @param string $type
* The dependency type: 'config', 'content', 'module' or 'theme'.
* @param string $key
* The string to be checked.
* @param \Drupal\Core\Entity\Display\EntityDisplayInterface $display
* The entity display object to get dependencies from.
*
* @return bool
* TRUE if the assertion succeeded, FALSE otherwise.
*/
protected function assertDependency($type, $key, EntityDisplayInterface $display) {
return $this->assertDependencyHelper(TRUE, $type, $key, $display);
}
/**
* Asserts that $key is not a $type type dependency of $display config entity.
*
* @param string $type
* The dependency type: 'config', 'content', 'module' or 'theme'.
* @param string $key
* The string to be checked.
* @param \Drupal\Core\Entity\Display\EntityDisplayInterface $display
* The entity display object to get dependencies from.
*
* @return bool
* TRUE if the assertion succeeded, FALSE otherwise.
*/
protected function assertNoDependency($type, $key, EntityDisplayInterface $display) {
return $this->assertDependencyHelper(FALSE, $type, $key, $display);
}
/**
* Provides a helper for dependency assertions.
*
* @param bool $assertion
* Assertion: positive or negative.
* @param string $type
* The dependency type: 'config', 'content', 'module' or 'theme'.
* @param string $key
* The string to be checked.
* @param \Drupal\Core\Entity\Display\EntityDisplayInterface $display
* The entity display object to get dependencies from.
*
* @return bool
* TRUE if the assertion succeeded, FALSE otherwise.
*/
protected function assertDependencyHelper($assertion, $type, $key, EntityDisplayInterface $display) {
$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);
return $this->assert($value, $message);
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|---|
AssertContentTrait::$content | protected | property | The current raw content. | |||
AssertContentTrait::$drupalSettings | protected | property | The drupalSettings value from the current raw $content. | |||
AssertContentTrait::$elements | protected | property | The XML structure parsed from the current raw $content. | 1 | ||
AssertContentTrait::$plainTextContent | protected | property | The plain-text content of raw $content (text nodes). | |||
AssertContentTrait::assertEscaped | protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |||
AssertContentTrait::assertField | protected | function | Asserts that a field exists with the given name or ID. | |||
AssertContentTrait::assertFieldById | protected | function | Asserts that a field exists with the given ID and value. | |||
AssertContentTrait::assertFieldByName | protected | function | Asserts that a field exists with the given name and value. | |||
AssertContentTrait::assertFieldByXPath | protected | function | Asserts that a field exists in the current page by the given XPath. | |||
AssertContentTrait::assertFieldChecked | protected | function | Asserts that a checkbox field in the current page is checked. | |||
AssertContentTrait::assertFieldsByValue | protected | function | Asserts that a field exists in the current page with a given Xpath result. | |||
AssertContentTrait::assertLink | protected | function | Passes if a link with the specified label is found. | |||
AssertContentTrait::assertLinkByHref | protected | function | Passes if a link containing a given href (part) is found. | |||
AssertContentTrait::assertNoDuplicateIds | protected | function | Asserts that each HTML ID is used for just a single element. | |||
AssertContentTrait::assertNoEscaped | protected | function | Passes if the raw text IS NOT found escaped on the loaded page, fail otherwise. |
|||
AssertContentTrait::assertNoField | protected | function | Asserts that a field does not exist with the given name or ID. | |||
AssertContentTrait::assertNoFieldById | protected | function | Asserts that a field does not exist with the given ID and value. | |||
AssertContentTrait::assertNoFieldByName | protected | function | Asserts that a field does not exist with the given name and value. | |||
AssertContentTrait::assertNoFieldByXPath | protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |||
AssertContentTrait::assertNoFieldChecked | protected | function | Asserts that a checkbox field in the current page is not checked. | |||
AssertContentTrait::assertNoLink | protected | function | Passes if a link with the specified label is not found. | |||
AssertContentTrait::assertNoLinkByHref | protected | function | Passes if a link containing a given href (part) is not found. | |||
AssertContentTrait::assertNoLinkByHrefInMainRegion | protected | function | Passes if a link containing a given href is not found in the main region. | |||
AssertContentTrait::assertNoOption | protected | function | Asserts that a select option in the current page does not exist. | |||
AssertContentTrait::assertNoOptionSelected | protected | function | Asserts that a select option in the current page is not checked. | |||
AssertContentTrait::assertNoPattern | protected | function | Triggers a pass if the perl regex pattern is not found in raw content. | |||
AssertContentTrait::assertNoRaw | protected | function | Passes if the raw text is NOT found on the loaded page, fail otherwise. | |||
AssertContentTrait::assertNoText | protected | function | Passes if the page (with HTML stripped) does not contains the text. | |||
AssertContentTrait::assertNoTitle | protected | function | Pass if the page title is not the given string. | |||
AssertContentTrait::assertNoUniqueText | protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |||
AssertContentTrait::assertOption | protected | function | Asserts that a select option in the current page exists. | |||
AssertContentTrait::assertOptionByText | protected | function | Asserts that a select option with the visible text exists. | |||
AssertContentTrait::assertOptionSelected | protected | function | Asserts that a select option in the current page is checked. | |||
AssertContentTrait::assertOptionSelectedWithDrupalSelector | protected | function | Asserts that a select option in the current page is checked. | |||
AssertContentTrait::assertOptionWithDrupalSelector | protected | function | Asserts that a select option in the current page exists. | |||
AssertContentTrait::assertPattern | protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |||
AssertContentTrait::assertRaw | protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |||
AssertContentTrait::assertText | protected | function | Passes if the page (with HTML stripped) contains the text. | |||
AssertContentTrait::assertTextHelper | protected | function | Helper for assertText and assertNoText. | |||
AssertContentTrait::assertTextPattern | protected | function | Asserts that a Perl regex pattern is found in the plain-text content. | |||
AssertContentTrait::assertThemeOutput | protected | function | Asserts themed output. | |||
AssertContentTrait::assertTitle | protected | function | Pass if the page title is the given string. | |||
AssertContentTrait::assertUniqueText | protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |||
AssertContentTrait::assertUniqueTextHelper | protected | function | Helper for assertUniqueText and assertNoUniqueText. | |||
AssertContentTrait::buildXPathQuery | protected | function | Builds an XPath query. | |||
AssertContentTrait::constructFieldXpath | protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |||
AssertContentTrait::cssSelect | protected | function | Searches elements using a CSS selector in the raw content. | |||
AssertContentTrait::getAllOptions | protected | function | Get all option elements, including nested options, in a select. | |||
AssertContentTrait::getDrupalSettings | protected | function | Gets the value of drupalSettings for the currently-loaded page. | |||
AssertContentTrait::getRawContent | protected | function | Gets the current raw content. | |||
AssertContentTrait::getSelectedItem | protected | function | Get the selected value from a select field. | |||
AssertContentTrait::getTextContent | protected | function | Retrieves the plain-text content from the current raw content. | |||
AssertContentTrait::getUrl | protected | function | Get the current URL from the cURL handler. | 1 | ||
AssertContentTrait::parse | protected | function | Parse content returned from curlExec using DOM and SimpleXML. | |||
AssertContentTrait::removeWhiteSpace | protected | function | Removes all white-space between HTML tags from the raw content. | |||
AssertContentTrait::setDrupalSettings | protected | function | Sets the value of drupalSettings for the currently-loaded page. | |||
AssertContentTrait::setRawContent | protected | function | Sets the raw content (e.g. HTML). | |||
AssertContentTrait::xpath | protected | function | Performs an xpath search on the contents of the internal browser. | |||
AssertHelperTrait::castSafeStrings | protected static | function | Casts MarkupInterface objects into strings. | |||
AssertLegacyTrait::assert | protected | function | ||||
AssertLegacyTrait::assertEqual | protected | function | ||||
AssertLegacyTrait::assertIdentical | protected | function | ||||
AssertLegacyTrait::assertIdenticalObject | protected | function | ||||
AssertLegacyTrait::assertNotEqual | protected | function | ||||
AssertLegacyTrait::assertNotIdentical | protected | function | ||||
AssertLegacyTrait::pass | protected | function | ||||
AssertLegacyTrait::verbose | protected | function | ||||
ConfigTestTrait::configImporter | protected | function | Returns a ConfigImporter object to import test configuration. | |||
ConfigTestTrait::copyConfig | protected | function | Copies configuration objects from source storage to target storage. | |||
EntityDisplayTest::$modules | public static | property | Modules to install. | Overrides KernelTestBase::$modules | ||
EntityDisplayTest::assertDependency | protected | function | Asserts that $key is a $type type dependency of $display config entity. | |||
EntityDisplayTest::assertDependencyHelper | protected | function | Provides a helper for dependency assertions. | |||
EntityDisplayTest::assertNoDependency | protected | function | Asserts that $key is not a $type type dependency of $display config entity. | |||
EntityDisplayTest::setUp | protected | function | Overrides KernelTestBase::setUp | |||
EntityDisplayTest::testBaseFieldComponent | public | function | Tests the behavior of a field component for a base field. | |||
EntityDisplayTest::testComponentDependencies | public | function | Tests components dependencies additions. | |||
EntityDisplayTest::testDeleteBundle | public | function | Tests deleting a bundle. | |||
EntityDisplayTest::testDeleteField | public | function | Tests deleting field. | |||
EntityDisplayTest::testEntityDisplayCRUD | public | function | Tests basic CRUD operations on entity display objects. | |||
EntityDisplayTest::testEntityDisplayCRUDSort | public | function | Test sorting of components by name on basic CRUD operations | |||
EntityDisplayTest::testEntityDisplayInvalidateCacheTags | public | function | Ensure that entity view display changes invalidates cache tags. | |||
EntityDisplayTest::testEntityGetDisplay | public | function | @covers \Drupal\Core\Entity\EntityDisplayRepository::getViewDisplay | |||
EntityDisplayTest::testExtraFieldComponent | public | function | Tests the behavior of a field component within an entity display object. | |||
EntityDisplayTest::testExtraFieldComponentInitialInvalidConfig | public | function | Tests the behavior of an extra field component with initial invalid values. | |||
EntityDisplayTest::testFieldComponent | public | function | Tests the behavior of a field component within an entity display object. | |||
EntityDisplayTest::testGetDisplayModeOptions | public | function | Test getDisplayModeOptions(). | |||
EntityDisplayTest::testOnDependencyRemoval | public | function | Tests \Drupal\Core\Entity\EntityDisplayBase::onDependencyRemoval(). | |||
KernelTestBase::$backupGlobals | protected | property | Back up and restore any global variables that may be changed by tests. | |||
KernelTestBase::$backupStaticAttributes | protected | property | Back up and restore static class properties that may be changed by tests. | |||
KernelTestBase::$backupStaticAttributesBlacklist | protected | property | Contains a few static class properties for performance. | |||
KernelTestBase::$classLoader | protected | property | ||||
KernelTestBase::$configImporter | protected | property | @todo Move into Config test base class. | 7 | ||
KernelTestBase::$configSchemaCheckerExclusions | protected static | property | An array of config object names that are excluded from schema checking. | |||
KernelTestBase::$container | protected | property | ||||
KernelTestBase::$databasePrefix | protected | property | ||||
KernelTestBase::$preserveGlobalState | protected | property | Do not forward any global state from the parent process to the processes that run the actual tests. |
|||
KernelTestBase::$root | protected | property | The app root. | |||
KernelTestBase::$runTestInSeparateProcess | protected | property | Kernel tests are run in separate processes because they allow autoloading of code from extensions. Running the test in a separate process isolates this behavior from other tests. Subclasses should not override this property. |
|||
KernelTestBase::$siteDirectory | protected | property | ||||
KernelTestBase::$strictConfigSchema | protected | property | Set to TRUE to strict check all configuration saved. | 6 | ||
KernelTestBase::$vfsRoot | protected | property | The virtual filesystem root directory. | |||
KernelTestBase::assertPostConditions | protected | function | 1 | |||
KernelTestBase::bootEnvironment | protected | function | Bootstraps a basic test environment. | |||
KernelTestBase::bootKernel | private | function | Bootstraps a kernel for a test. | |||
KernelTestBase::config | protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |||
KernelTestBase::disableModules | protected | function | Disables modules for this test. | |||
KernelTestBase::enableModules | protected | function | Enables modules for this test. | |||
KernelTestBase::getConfigSchemaExclusions | protected | function | Gets the config schema exclusions for this test. | |||
KernelTestBase::getDatabaseConnectionInfo | protected | function | Returns the Database connection info to be used for this test. | 1 | ||
KernelTestBase::getDatabasePrefix | public | function | ||||
KernelTestBase::getExtensionsForModules | private | function | Returns Extension objects for $modules to enable. | |||
KernelTestBase::getModulesToEnable | private static | function | Returns the modules to enable for this test. | |||
KernelTestBase::initFileCache | protected | function | Initializes the FileCache component. | |||
KernelTestBase::installConfig | protected | function | Installs default configuration for a given list of modules. | |||
KernelTestBase::installEntitySchema | protected | function | Installs the storage schema for a specific entity type. | |||
KernelTestBase::installSchema | protected | function | Installs database tables from a module schema definition. | |||
KernelTestBase::isTestInIsolation | Deprecated | protected | function | Returns whether the current test method is running in a separate process. | ||
KernelTestBase::prepareTemplate | protected | function | ||||
KernelTestBase::register | public | function | Registers test-specific services. | Overrides ServiceProviderInterface::register | 26 | |
KernelTestBase::render | protected | function | Renders a render array. | 1 | ||
KernelTestBase::setInstallProfile | protected | function | Sets the install profile and rebuilds the container to update it. | |||
KernelTestBase::setSetting | protected | function | Sets an in-memory Settings variable. | |||
KernelTestBase::setUpBeforeClass | public static | function | 1 | |||
KernelTestBase::setUpFilesystem | protected | function | Sets up the filesystem, so things like the file directory. | 2 | ||
KernelTestBase::stop | protected | function | Stops test execution. | |||
KernelTestBase::tearDown | protected | function | 5 | |||
KernelTestBase::tearDownCloseDatabaseConnection | public | function | @after | |||
KernelTestBase::vfsDump | protected | function | Dumps the current state of the virtual filesystem to STDOUT. | |||
KernelTestBase::__get | Deprecated | public | function | BC: Automatically resolve former KernelTestBase class properties. | ||
KernelTestBase::__sleep | public | function | Prevents serializing any properties. | |||
PhpunitCompatibilityTrait::getMock | Deprecated | public | function | Returns a mock object for the specified class using the available method. | ||
PhpunitCompatibilityTrait::setExpectedException | Deprecated | public | function | Compatibility layer for PHPUnit 6 to support PHPUnit 4 code. | ||
RandomGeneratorTrait::$randomGenerator | protected | property | The random generator. | |||
RandomGeneratorTrait::getRandomGenerator | protected | function | Gets the random generator for the utility methods. | |||
RandomGeneratorTrait::randomMachineName | protected | function | Generates a unique random string containing letters and numbers. | 1 | ||
RandomGeneratorTrait::randomObject | public | function | Generates a random PHP object. | |||
RandomGeneratorTrait::randomString | public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |||
RandomGeneratorTrait::randomStringValidate | public | function | Callback for random string validation. | |||
StorageCopyTrait::replaceStorageContents | protected static | function | Copy the configuration from one storage to another and remove stale items. | |||
TestRequirementsTrait::checkModuleRequirements | private | function | Checks missing module requirements. | |||
TestRequirementsTrait::checkRequirements | protected | function | Check module requirements for the Drupal use case. | 1 | ||
TestRequirementsTrait::getDrupalRoot | protected static | function | Returns the Drupal root directory. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.