View source
<?php
namespace Drupal\Tests\dynamic_entity_reference\Functional;
use Drupal\Component\Utility\Crypt;
use Drupal\Core\Field\FieldStorageDefinitionInterface;
use Drupal\Core\Language\LanguageInterface;
use Drupal\Core\Site\Settings;
use Drupal\Core\Url;
use Drupal\dynamic_entity_reference\Plugin\Field\FieldType\DynamicEntityReferenceItem;
use Drupal\entity_test\Entity\EntityTest;
use Drupal\entity_test\Entity\EntityTestBundle;
use Drupal\field\Entity\FieldConfig;
use Drupal\field\Entity\FieldStorageConfig;
use Drupal\taxonomy\Entity\Term;
use Drupal\taxonomy\Entity\Vocabulary;
use Drupal\Tests\BrowserTestBase;
class DynamicEntityReferenceTest extends BrowserTestBase {
protected $adminUser;
protected $anotherUser;
protected static $modules = [
'field_ui',
'dynamic_entity_reference',
'entity_test',
];
protected $permissions = [
'access administration pages',
'view test entity',
'administer entity_test fields',
'administer entity_test content',
'access user profiles',
];
protected $defaultTheme = 'stark';
protected function setUp() : void {
parent::setUp();
$this->adminUser = $this
->drupalCreateUser($this->permissions);
$this->anotherUser = $this
->drupalCreateUser();
}
public function testFieldSettings() {
$assert_session = $this
->assertSession();
EntityTestBundle::create([
'id' => 'test',
'label' => 'Test label',
'description' => 'My test description',
])
->save();
$this
->drupalLogin($this->adminUser);
$this
->drupalGet('entity_test/structure/entity_test/fields/add-field');
$edit = [
'label' => 'Foobar',
'field_name' => 'foobar',
'new_storage_type' => 'dynamic_entity_reference',
];
$this
->submitForm($edit, t('Save and continue'));
$assert_session
->optionNotExists('settings[entity_type_ids][]', 'settings[entity_test_no_id][handler_settings][target_bundles][entity_test_no_id]');
$assert_session
->optionNotExists('settings[entity_type_ids][]', 'settings[entity_test_no_id][handler_settings][target_bundles][entity_test_string_id]');
$this
->submitForm([
'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
'settings[entity_type_ids][]' => [
'user',
'entity_test_label',
],
], t('Save field settings'));
$assert_session
->fieldExists('default_value_input[field_foobar][0][target_type]');
$assert_session
->optionExists('default_value_input[field_foobar][0][target_type]', 'entity_test');
$assert_session
->optionNotExists('default_value_input[field_foobar][0][target_type]', 'user');
$labels = $this->container
->get('entity_type.repository')
->getEntityTypeLabels(TRUE);
$edit = [];
$excluded_entity_type_ids = [
'user',
'file',
'path_alias',
'entity_test_label',
'entity_test_no_id',
'entity_test_no_bundle',
'entity_test_string_id',
'entity_test_computed_field',
'entity_test_map_field',
'entity_test_no_bundle_with_label',
];
foreach ($labels[(string) t('Content', [], [
'context' => 'Entity type group',
])] as $entity_type_id => $entity_type_label) {
if (!in_array($entity_type_id, $excluded_entity_type_ids)) {
if ($entity_type_id !== 'entity_test_with_bundle') {
$edit["settings[{$entity_type_id}][handler_settings][target_bundles][{$entity_type_id}]"] = TRUE;
}
else {
$edit['settings[entity_test_with_bundle][handler_settings][target_bundles][test]'] = TRUE;
}
}
}
$this
->submitForm($edit, t('Save settings'));
$assert_session
->responseContains(t('Saved %name configuration', [
'%name' => 'Foobar',
]));
$excluded_entity_type_ids = FieldStorageConfig::loadByName('entity_test', 'field_foobar')
->getSetting('entity_type_ids');
$this
->assertNotNull($excluded_entity_type_ids);
$this
->assertSame(array_keys($excluded_entity_type_ids), [
'user',
'entity_test_label',
]);
$this
->drupalGet('entity_test/structure/entity_test/fields/entity_test.entity_test.field_foobar/storage');
$this
->submitForm([
'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
'settings[exclude_entity_types]' => FALSE,
'settings[entity_type_ids][]' => [],
], t('Save field settings'));
$assert_session
->pageTextContains('Select at least one entity type ID.');
$options = array_filter(array_keys($labels[(string) t('Content', [], [
'context' => 'Entity type group',
])]), function ($entity_type_id) {
return DynamicEntityReferenceItem::entityHasIntegerId($entity_type_id);
});
unset($options['entity_test_no_id']);
$this
->submitForm([
'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
'settings[exclude_entity_types]' => TRUE,
'settings[entity_type_ids][]' => $options,
], t('Save field settings'));
$assert_session
->pageTextContains('Select at least one entity type ID.');
$this
->submitForm([
'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
'settings[exclude_entity_types]' => FALSE,
'settings[entity_type_ids][]' => [
'user',
'entity_test_label',
],
], t('Save field settings'));
$this
->drupalGet('entity_test/structure/entity_test/fields/entity_test.entity_test.field_foobar');
$assert_session
->fieldExists('default_value_input[field_foobar][0][target_type]');
$assert_session
->optionNotExists('default_value_input[field_foobar][0][target_type]', 'entity_test');
$assert_session
->optionExists('default_value_input[field_foobar][0][target_type]', 'user');
$edit = [
'settings[entity_test_label][handler_settings][target_bundles][entity_test_label]' => 'entity_test_label',
];
$this
->submitForm($edit, t('Save settings'));
$assert_session
->responseContains(t('Saved %name configuration', [
'%name' => 'Foobar',
]));
$excluded_entity_type_ids = FieldStorageConfig::loadByName('entity_test', 'field_foobar')
->getSetting('entity_type_ids');
$this
->assertNotNull($excluded_entity_type_ids);
$this
->assertSame(array_keys($excluded_entity_type_ids), [
'user',
'entity_test_label',
]);
$this
->drupalGet('entity_test/structure/entity_test/fields/entity_test.entity_test.field_foobar');
$this
->submitForm([
'default_value_input[field_foobar][0][target_type]' => 'user',
'default_value_input[field_foobar][0][target_id]' => $this->adminUser
->label() . ' (' . $this->adminUser
->id() . ')',
], t('Save settings'));
$field_config = FieldConfig::loadByName('entity_test', 'entity_test', 'field_foobar')
->toArray();
$this
->assertEquals($field_config['default_value']['0'], [
'target_type' => 'user',
'target_uuid' => $this->adminUser
->uuid(),
]);
}
public function testDynamicEntityReference() {
$assert_session = $this
->assertSession();
EntityTestBundle::create([
'id' => 'test',
'label' => 'Test label',
'description' => 'My test description',
])
->save();
$this
->drupalLogin($this->adminUser);
$this
->drupalGet('entity_test/structure/entity_test/fields/add-field');
$edit = [
'label' => 'Foobar',
'field_name' => 'foobar',
'new_storage_type' => 'dynamic_entity_reference',
];
$this
->submitForm($edit, t('Save and continue'));
$assert_session
->optionNotExists('settings[entity_type_ids][]', 'settings[entity_test_no_id][handler_settings][target_bundles][entity_test_no_id]');
$assert_session
->optionNotExists('settings[entity_type_ids][]', 'settings[entity_test_no_id][handler_settings][target_bundles][entity_test_string_id]');
$this
->submitForm([
'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
], t('Save field settings'));
$assert_session
->fieldNotExists('settings[entity_test_no_id][handler_settings][target_bundles][entity_test_no_id]');
$assert_session
->fieldNotExists('settings[entity_test_string_id][handler_settings][target_bundles][entity_test_string_id]');
$labels = $this->container
->get('entity_type.repository')
->getEntityTypeLabels(TRUE);
$edit = [];
$excluded_entity_type_ids = [
'user',
'file',
'path_alias',
'entity_test_no_id',
'entity_test_no_bundle',
'entity_test_string_id',
'entity_test_computed_field',
'entity_test_map_field',
'entity_test_no_bundle_with_label',
];
foreach ($labels[(string) t('Content', [], [
'context' => 'Entity type group',
])] as $entity_type_id => $entity_type_label) {
if (!in_array($entity_type_id, $excluded_entity_type_ids)) {
if ($entity_type_id !== 'entity_test_with_bundle') {
$edit["settings[{$entity_type_id}][handler_settings][target_bundles][{$entity_type_id}]"] = TRUE;
}
else {
$edit['settings[entity_test_with_bundle][handler_settings][target_bundles][test]'] = TRUE;
}
}
}
$this
->submitForm($edit, t('Save settings'));
$assert_session
->responseContains(t('Saved %name configuration', [
'%name' => 'Foobar',
]));
\Drupal::service('entity_field.manager')
->clearCachedFieldDefinitions();
$item1 = EntityTest::create([
'name' => 'item1',
]);
$item1
->save();
$item2 = EntityTest::create([
'name' => 'item2',
]);
$item2
->save();
$this
->drupalGet('entity_test/add');
$assert_session
->fieldExists('field_foobar[0][target_id]');
$assert_session
->fieldExists('field_foobar[0][target_type]');
$input = $assert_session
->fieldExists('field_foobar[0][target_id]');
$settings = FieldConfig::loadByName('entity_test', 'entity_test', 'field_foobar')
->getSettings();
$selection_settings = $settings['entity_test_computed_field']['handler_settings'] ?: [];
$selection_settings += [
'match_operator' => 'CONTAINS',
'match_limit' => 10,
];
$data = serialize($selection_settings) . 'entity_test_computed_field' . $settings['entity_test_computed_field']['handler'];
$selection_settings_key = Crypt::hmacBase64($data, Settings::getHashSalt());
$expected_autocomplete_path = Url::fromRoute('system.entity_autocomplete', [
'target_type' => 'entity_test_computed_field',
'selection_handler' => $settings['entity_test_computed_field']['handler'],
'selection_settings_key' => $selection_settings_key,
])
->toString();
$this
->assertStringContainsString($input
->getAttribute('data-autocomplete-path'), $expected_autocomplete_path);
$this
->getSession()
->getPage()
->findButton('Add another item')
->click();
$this
->getSession()
->getPage()
->findButton('Add another item')
->click();
$edit = [
'field_foobar[0][target_id]' => $this->anotherUser
->label() . ' (' . $this->anotherUser
->id() . ')',
'field_foobar[0][target_type]' => 'user',
'field_foobar[1][target_id]' => 'item1',
'field_foobar[1][target_type]' => 'entity_test',
'field_foobar[2][target_id]' => 'item2 (' . $item2
->id() . ')',
'field_foobar[2][target_type]' => 'entity_test',
'name[0][value]' => 'Barfoo',
'user_id[0][target_id]' => $this->adminUser
->label() . ' (' . $this->adminUser
->id() . ')',
];
$this
->submitForm($edit, t('Save'));
$entities = \Drupal::entityTypeManager()
->getStorage('entity_test')
->loadByProperties([
'name' => 'Barfoo',
]);
$this
->assertCount(1, $entities, 'Entity was saved');
$entity = reset($entities);
$this
->drupalGet('entity_test/' . $entity
->id());
$assert_session
->pageTextContains('Barfoo');
$assert_session
->pageTextContains($this->anotherUser
->label());
$assert_session
->pageTextContains('item1');
$assert_session
->pageTextContains('item2');
$this
->assertCount(3, $entity->field_foobar, 'Three items in field');
$this
->assertEquals($entity->field_foobar[0]->entity
->label(), $this->anotherUser
->label());
$this
->assertEquals($entity->field_foobar[1]->entity
->label(), 'item1');
$this
->assertEquals($entity->field_foobar[2]->entity
->label(), 'item2');
$this
->drupalGet('entity_test/manage/' . $entity
->id() . '/edit');
$expected_entity_types = [
'0' => 'user',
'1' => 'entity_test',
'2' => 'entity_test',
];
foreach ($expected_entity_types as $index => $expected_entity_type) {
$selection_settings = $settings[$expected_entity_type]['handler_settings'] ?: [];
$selection_settings += [
'match_operator' => 'CONTAINS',
'match_limit' => 10,
];
$data = serialize($selection_settings) . $expected_entity_type . $settings[$expected_entity_type]['handler'];
$selection_settings_key = Crypt::hmacBase64($data, Settings::getHashSalt());
$input = $assert_session
->fieldExists('field_foobar[' . $index . '][target_id]');
$expected_autocomplete_path = Url::fromRoute('system.entity_autocomplete', [
'target_type' => $expected_entity_type,
'selection_handler' => $settings[$expected_entity_type]['handler'],
'selection_settings_key' => $selection_settings_key,
])
->toString();
$this
->assertStringContainsString($input
->getAttribute('data-autocomplete-path'), $expected_autocomplete_path);
}
$edit = [
'name[0][value]' => 'Bazbar',
'field_foobar[2][target_id]' => '',
];
$this
->submitForm($edit, t('Save'));
$this
->drupalGet('entity_test/' . $entity
->id());
$assert_session
->pageTextContains('Bazbar');
\Drupal::entityTypeManager()
->getStorage('entity_test')
->resetCache([
$entity
->id(),
]);
$entity = EntityTest::load($entity
->id());
$this
->assertCount(2, $entity->field_foobar, 'Two values in field');
$labels = [];
$duplicates = [];
for ($i = 0; $i < 2; $i++) {
$duplicates[$i] = EntityTest::create([
'name' => 'duplicate label',
]);
$duplicates[$i]
->save();
$labels[$i] = $duplicates[$i]
->label() . ' (' . $duplicates[$i]
->id() . ')';
}
$this
->drupalGet('entity_test/manage/' . $entity
->id() . '/edit');
$edit = [
'field_foobar[1][target_id]' => 'duplicate label',
];
$this
->submitForm($edit, t('Save'));
if (version_compare(\Drupal::VERSION, '9.2', '>=')) {
$error_message = t('Multiple test entity entities match this reference;');
}
else {
$error_message = t('Multiple entities match this reference;');
}
$assert_session
->responseContains($error_message);
$assert_session
->responseContains($labels[0]);
$assert_session
->responseContains($labels[1]);
for ($i = 2; $i < 7; $i++) {
$duplicates[$i] = EntityTest::create([
'name' => 'duplicate label',
]);
$duplicates[$i]
->save();
$labels[$i] = $duplicates[$i]
->label() . ' (' . $duplicates[$i]
->id() . ')';
}
$this
->submitForm($edit, t('Save'));
$params = [
'%value' => 'duplicate label',
];
if (version_compare(\Drupal::VERSION, '9.2', '>=')) {
$error_message = t('Many test entity entities are called %value. Specify the one you want by appending the id in parentheses', $params);
}
else {
$error_message = t('Many entities are called %value. Specify the one you want by appending the id in parentheses', $params);
}
$assert_session
->responseContains($error_message);
$this
->drupalGet('entity_test/manage/' . $entity
->id() . '/edit');
$edit = [
'field_foobar[1][target_id]' => 'does not exist',
];
$this
->submitForm($edit, t('Save'));
if (version_compare(\Drupal::VERSION, '9.2', '>=')) {
$assert_session
->responseContains(t('There are no test entity entities matching "%value".', [
'%value' => 'does not exist',
]));
}
else {
$assert_session
->responseContains(t('There are no entities matching "%value".', [
'%value' => 'does not exist',
]));
}
$this
->drupalGet('entity_test/manage/' . $entity
->id() . '/edit');
$edit = [
'name[0][value]' => 'Bazbar',
'field_foobar[1][target_id]' => 'Bazbar (' . $entity
->id() . ')',
];
$this
->submitForm($edit, t('Save'));
$this
->drupalGet('entity_test/' . $entity
->id());
$assert_session
->pageTextContains('Bazbar');
\Drupal::entityTypeManager()
->getStorage('entity_test')
->resetCache([
$entity
->id(),
]);
$entity = EntityTest::load($entity
->id());
$this
->assertEquals($entity->field_foobar[1]->entity
->label(), 'Bazbar');
}
public function testDynamicEntityReferenceAutoCreate() {
$assert_session = $this
->assertSession();
\Drupal::service('module_installer')
->install([
'taxonomy',
]);
$vocabulary = Vocabulary::create([
'name' => $this
->randomMachineName(),
'vid' => mb_strtolower($this
->randomMachineName()),
'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
]);
$vocabulary
->save();
$term = Term::create([
'name' => $this
->randomMachineName(),
'vid' => $vocabulary
->id(),
'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
]);
$term
->save();
$this
->drupalLogin($this->adminUser);
$this
->drupalGet('entity_test/structure/entity_test/fields/add-field');
$edit = [
'label' => 'Foobar',
'field_name' => 'foobar',
'new_storage_type' => 'dynamic_entity_reference',
];
$this
->submitForm($edit, t('Save and continue'));
$this
->submitForm([
'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
'settings[exclude_entity_types]' => FALSE,
'settings[entity_type_ids][]' => [
'taxonomy_term',
'user',
],
], t('Save field settings'));
$edit = [
'settings[taxonomy_term][handler_settings][target_bundles][' . $vocabulary
->id() . ']' => $vocabulary
->id(),
'settings[taxonomy_term][handler_settings][auto_create]' => TRUE,
];
$this
->submitForm($edit, t('Save settings'));
\Drupal::service('entity_field.manager')
->clearCachedFieldDefinitions();
$this
->drupalGet('entity_test/add');
$this
->getSession()
->getPage()
->findButton('Add another item')
->click();
$this
->getSession()
->getPage()
->findButton('Add another item')
->click();
$edit = [
'field_foobar[0][target_id]' => $this->adminUser
->label() . ' (' . $this->adminUser
->id() . ')',
'field_foobar[0][target_type]' => 'user',
'field_foobar[1][target_id]' => 'tag',
'field_foobar[1][target_type]' => 'taxonomy_term',
'field_foobar[2][target_id]' => $term
->label() . ' (' . $term
->id() . ')',
'field_foobar[2][target_type]' => 'taxonomy_term',
'name[0][value]' => 'Barfoo',
'user_id[0][target_id]' => $this->adminUser
->label() . ' (' . $this->adminUser
->id() . ')',
];
$this
->submitForm($edit, t('Save'));
$entities = \Drupal::entityTypeManager()
->getStorage('entity_test')
->loadByProperties([
'name' => 'Barfoo',
]);
$this
->assertCount(1, $entities, 'Entity was saved');
$entity = reset($entities);
$this
->assertCount(3, $entity->field_foobar, 'Three items in field');
$this
->assertEquals($entity->field_foobar[0]->entity
->label(), $this->adminUser
->label());
$this
->assertEquals($entity->field_foobar[1]->entity
->label(), 'tag');
$this
->assertEquals($entity->field_foobar[2]->entity
->label(), $term
->label());
$this
->drupalGet('entity_test/' . $entity
->id());
$assert_session
->pageTextContains('Barfoo');
$assert_session
->pageTextContains($this->adminUser
->label());
$assert_session
->pageTextContains('tag');
$assert_session
->pageTextContains($term
->label());
}
public function testNodePreview() {
$assert_session = $this
->assertSession();
\Drupal::service('module_installer')
->install([
'taxonomy',
'node',
]);
$this
->drupalCreateContentType([
'type' => 'article',
]);
$this->permissions = [
'access content',
'administer nodes',
'administer node fields',
'create article content',
];
$this->adminUser = $this
->drupalCreateUser($this->permissions);
$vocabulary = Vocabulary::create([
'name' => $this
->randomMachineName(),
'vid' => mb_strtolower($this
->randomMachineName()),
'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
]);
$vocabulary
->save();
$term = Term::create([
'name' => $this
->randomMachineName(),
'vid' => $vocabulary
->id(),
'langcode' => LanguageInterface::LANGCODE_NOT_SPECIFIED,
]);
$term
->save();
$this
->drupalLogin($this->adminUser);
$this
->drupalGet('admin/structure/types/manage/article/fields/add-field');
$edit = [
'label' => 'DER',
'field_name' => 'der',
'new_storage_type' => 'dynamic_entity_reference',
];
$this
->submitForm($edit, t('Save and continue'));
$this
->submitForm([
'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
'settings[exclude_entity_types]' => FALSE,
'settings[entity_type_ids][]' => [
'taxonomy_term',
'entity_test_label',
],
], t('Save field settings'));
$edit = [
'settings[entity_test_label][handler_settings][target_bundles][entity_test_label]' => 'entity_test_label',
'settings[taxonomy_term][handler_settings][target_bundles][' . $vocabulary
->id() . ']' => $vocabulary
->id(),
'settings[taxonomy_term][handler_settings][auto_create]' => TRUE,
];
$this
->submitForm($edit, t('Save settings'));
\Drupal::service('entity_field.manager')
->clearCachedFieldDefinitions();
$this
->drupalGet('node/add/article');
$assert_session
->fieldExists('field_der[0][target_id]');
$assert_session
->fieldExists('field_der[0][target_type]');
$title = $this
->randomMachineName();
$edit = [
'field_der[0][target_id]' => $term
->label() . ' (' . $term
->id() . ')',
'field_der[0][target_type]' => 'taxonomy_term',
'title[0][value]' => $title,
'uid[0][target_id]' => $this->adminUser
->label() . ' (' . $this->adminUser
->id() . ')',
];
$this
->submitForm($edit, t('Preview'));
$assert_session
->pageTextContains($title);
$assert_session
->pageTextContains($term
->label());
$this
->clickLink('Back to content editing');
$assert_session
->fieldValueEquals('field_der[0][target_id]', $term
->label() . ' (' . $term
->id() . ')');
$this
->drupalGet('node/add/article');
$assert_session
->fieldExists('field_der[0][target_id]');
$assert_session
->fieldExists('field_der[0][target_type]');
$new_term = $this
->randomMachineName();
$edit = [
'field_der[0][target_id]' => $new_term,
'field_der[0][target_type]' => 'taxonomy_term',
'title[0][value]' => $title,
'uid[0][target_id]' => $this->adminUser
->label() . ' (' . $this->adminUser
->id() . ')',
];
$this
->submitForm($edit, t('Preview'));
$assert_session
->pageTextContains($title);
$assert_session
->pageTextContains($new_term);
$this
->clickLink('Back to content editing');
$assert_session
->fieldValueEquals('field_der[0][target_id]', $new_term);
}
}