diff --git a/core/config/schema/core.data_types.schema.yml b/core/config/schema/core.data_types.schema.yml index 79e3f14..04e7582 100644 --- a/core/config/schema/core.data_types.schema.yml +++ b/core/config/schema/core.data_types.schema.yml @@ -774,9 +774,6 @@ entity_reference_selection: direction: type: string label: 'Sort direction' - auto_create: - type: boolean - label: 'Create referenced entities if they don''t already exist' entity_reference_selection.*: type: entity_reference_selection diff --git a/core/config/schema/core.entity.schema.yml b/core/config/schema/core.entity.schema.yml index cc1a57e..17ccada 100644 --- a/core/config/schema/core.entity.schema.yml +++ b/core/config/schema/core.entity.schema.yml @@ -213,6 +213,12 @@ field.widget.settings.entity_reference_autocomplete_tags: placeholder: type: label label: 'Placeholder' + auto_create: + type: boolean + label: 'Create referenced entities if they don''t already exist' + auto_create_bundle: + type: string + label: 'Bundle assigned to the auto-created entities.' field.widget.settings.entity_reference_autocomplete: type: mapping @@ -227,6 +233,12 @@ field.widget.settings.entity_reference_autocomplete: placeholder: type: label label: 'Placeholder' + auto_create: + type: boolean + label: 'Create referenced entities if they don''t already exist' + auto_create_bundle: + type: string + label: 'Bundle assigned to the auto-created entities.' field.formatter.settings.boolean: type: mapping diff --git a/core/lib/Drupal/Core/Entity/Plugin/EntityReferenceSelection/SelectionBase.php b/core/lib/Drupal/Core/Entity/Plugin/EntityReferenceSelection/SelectionBase.php index cb8c7d6..2324fc7 100644 --- a/core/lib/Drupal/Core/Entity/Plugin/EntityReferenceSelection/SelectionBase.php +++ b/core/lib/Drupal/Core/Entity/Plugin/EntityReferenceSelection/SelectionBase.php @@ -115,7 +115,6 @@ public function buildConfigurationForm(array $form, FormStateInterface $form_sta 'sort' => array( 'field' => '_none', ), - 'auto_create' => FALSE, ); if ($entity_type->hasKey('bundle')) { diff --git a/core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/EntityReferenceAutocompleteWidget.php b/core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/EntityReferenceAutocompleteWidget.php index 948079e..2c3803c 100644 --- a/core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/EntityReferenceAutocompleteWidget.php +++ b/core/lib/Drupal/Core/Field/Plugin/Field/FieldWidget/EntityReferenceAutocompleteWidget.php @@ -35,6 +35,8 @@ public static function defaultSettings() { 'match_operator' => 'CONTAINS', 'size' => '60', 'placeholder' => '', + 'auto_create' => FALSE, + 'auto_create_bundle' => NULL, ) + parent::defaultSettings(); } @@ -42,6 +44,9 @@ public static function defaultSettings() { * {@inheritdoc} */ public function settingsForm(array $form, FormStateInterface $form_state) { + $entity_type_id = $this->getFieldSetting('target_type'); + $entity_type = \Drupal::entityManager()->getDefinition($entity_type_id); + $element['match_operator'] = array( '#type' => 'radios', '#title' => t('Autocomplete matching'), @@ -62,6 +67,35 @@ public function settingsForm(array $form, FormStateInterface $form_state) { '#default_value' => $this->getSetting('placeholder'), '#description' => t('Text that will be shown inside the field until a value is entered. This hint is usually a sample value or a brief description of the expected format.'), ); + $element['auto_create'] = array( + '#type' => 'checkbox', + '#title' => $this->t("Create referenced entities if they don't already exist"), + '#default_value' => $this->getSetting('auto_create'), + ); + + $bundles = $this->getSelectionHandlerSetting('target_bundles'); + if ($entity_type->hasKey('bundle') && $bundles && count($bundles) > 1) { + $options = array(); + foreach (\Drupal::entityManager()->getBundleInfo($entity_type_id) as $id => $info) { + if (in_array($id, $bundles)) { + $options[$id] = $info['label']; + } + } + + $selector_name = 'fields[' . $this->fieldDefinition->getName() . '][settings_edit_form][settings][auto_create]'; + $element['auto_create_bundle'] = array( + '#type' => 'select', + '#title' => $this->t('Store new items in'), + '#options' => $options, + '#default_value' => $this->getSetting('auto_create_bundle'), + '#states' => array( + 'visible' => array( + ':input[name="' . $selector_name . '"]' => array('checked' => TRUE), + ), + ), + ); + } + return $element; } @@ -82,6 +116,24 @@ public function settingsSummary() { $summary[] = t('No placeholder'); } + if ($this->getSetting('auto_create')) { + $entity_type_id = $this->getFieldSetting('target_type'); + $entity_type = \Drupal::entityManager()->getDefinition($entity_type_id); + $bundle_id = $this->getSetting('auto_create_bundle'); + if ($bundle_id) { + $bundle_type = $entity_type->getBundleEntityType(); + $storage = \Drupal::entityManager()->getStorage($bundle_type); + $bundle = $storage->load($bundle_id); + $summary[] = $this->t('Auto-create the %entity in %bundle, if is not in selection list', ['%entity' => $entity_type->getLabel(), '%bundle' => $bundle->label()]); + } + else { + $summary[] = $this->t('Auto-create %entity, if is not in selection list', ['%entity' => $entity_type->getLabel()]); + } + } + else { + $summary[] = $this->t('No entity auto-creation. Selection limited to list.'); + } + return $summary; } @@ -106,7 +158,7 @@ public function formElement(FieldItemListInterface $items, $delta, array $elemen '#placeholder' => $this->getSetting('placeholder'), ); - if ($this->getSelectionHandlerSetting('auto_create')) { + if ($this->getSetting('auto_create')) { $element['#autocreate'] = array( 'bundle' => $this->getAutocreateBundle(), 'uid' => ($entity instanceof EntityOwnerInterface) ? $entity->getOwnerId() : \Drupal::currentUser()->id() @@ -144,21 +196,27 @@ public function massageFormValues(array $values, array $form, FormStateInterface * * @return string * The bundle name. + * + * @throws \InvalidArgumentException + * Thrown when the field allows references from multiple target bundles, + * 'auto_create' is enabled and 'auto_create_bundle' is not set. */ protected function getAutocreateBundle() { $bundle = NULL; - if ($this->getSelectionHandlerSetting('auto_create')) { - // If the 'target_bundles' setting is restricted to a single choice, we - // can use that. - if (($target_bundles = $this->getSelectionHandlerSetting('target_bundles')) && count($target_bundles) == 1) { + if ($this->getSetting('auto_create') && $target_bundles = $this->getSelectionHandlerSetting('target_bundles')) { + // If there's only one target bundle, use it. + if (count($target_bundles) == 1) { $bundle = reset($target_bundles); } - // Otherwise use the first bundle as a fallback. - else { - // @todo Expose a proper UI for choosing the bundle for autocreated - // entities in https://www.drupal.org/node/2412569. - $bundles = entity_get_bundles($this->getFieldSetting('target_type')); - $bundle = key($bundles); + // Otherwise use the target bundle stored in widget settings. + elseif (!$bundle = $this->getSetting('auto_create_bundle')) { + // If no bundle has been set as auto create target means that there is + // an inconsistency in entity reference field settings. + throw new \InvalidArgumentException(sprintf( + "Create referenced entities if they don't already exist option is enabled but a specific destination bundle is not set. You should re-visit 'Manage form display' and fix the widget settings of the '%s' (%s) field.", + $this->fieldDefinition->getLabel(), + $this->fieldDefinition->getName() + )); } } diff --git a/core/modules/entity_reference/src/Tests/EntityReferenceAdminTest.php b/core/modules/entity_reference/src/Tests/EntityReferenceAdminTest.php index 0956896..e81612f 100644 --- a/core/modules/entity_reference/src/Tests/EntityReferenceAdminTest.php +++ b/core/modules/entity_reference/src/Tests/EntityReferenceAdminTest.php @@ -7,7 +7,9 @@ namespace Drupal\entity_reference\Tests; +use Drupal\Component\Utility\Unicode; use Drupal\Core\Entity\Entity; +use Drupal\Core\Entity\Entity\EntityFormDisplay; use Drupal\field_ui\Tests\FieldUiTestTrait; use Drupal\node\Entity\Node; use Drupal\simpletest\WebTestBase; @@ -57,6 +59,7 @@ protected function setUp() { 'access content', 'administer node fields', 'administer node display', + 'administer node form display', 'administer views', 'create ' . $type_name . ' content', 'edit own ' . $type_name . ' content', @@ -146,7 +149,6 @@ public function testFieldAdminHandler() { ); $this->drupalPostForm($bundle_path . '/fields/' . $field_name . '/storage', $edit, t('Save field settings')); $this->drupalGet($bundle_path . '/fields/' . $field_name); - $this->assertFieldByName('settings[handler_settings][auto_create]'); // Switch the target type to 'user' and check that the settings specific to // its selection handler are displayed. @@ -307,13 +309,13 @@ public function testAvailableFormatters() { Vocabulary::create(array('vid' => 'tags', 'name' => 'tags'))->save(); // Create entity reference field with taxonomy term as a target. - $taxonomy_term_field_name = $this->createEntityReferenceField('taxonomy_term', 'tags'); + $taxonomy_term_field_name = $this->createEntityReferenceField('taxonomy_term', ['tags']); // Create entity reference field with user as a target. $user_field_name = $this->createEntityReferenceField('user'); // Create entity reference field with node as a target. - $node_field_name = $this->createEntityReferenceField('node', $this->type); + $node_field_name = $this->createEntityReferenceField('node', [$this->type]); // Create entity reference field with date format as a target. $date_format_field_name = $this->createEntityReferenceField('date_format'); @@ -362,17 +364,94 @@ public function testAvailableFormatters() { } /** + * Tests field settings for an entity reference field when the field has + * multiple target bundles and is set to auto-create the target entity. + */ + public function testMultipleTargetBundles() { + /** @var \Drupal\taxonomy\Entity\Vocabulary[] $vocabularies */ + $vocabularies = []; + for ($i = 0; $i < 2; $i++) { + $vid = Unicode::strtolower($this->randomMachineName()); + $vocabularies[$i] = Vocabulary::create([ + 'name' => $this->randomString(), + 'vid' => $vid, + ]); + $vocabularies[$i]->save(); + } + + // Create a new field pointing to the first vocabulary. + $field_name = $this->createEntityReferenceField('taxonomy_term', [$vocabularies[0]->id()]); + $field_name = "field_$field_name"; + $field_id = 'node.' . $this->type . '.' . $field_name; + $form_display_path = 'admin/structure/types/manage/' . $this->type . '/form-display'; + $triggering_element = $field_name . '_settings_edit'; + + // Set the widget of this field to 'entity_reference_autocomplete_tags'. + $this->drupalPostForm($form_display_path, ["fields[$field_name][type]" => 'entity_reference_autocomplete_tags'], t('Save')); + + // Open the widget settings for the created field. + $this->drupalPostAjaxForm(NULL, [], $triggering_element); + + // Expect that there's no 'auto_create_bundle' selected. + $this->assertNoFieldByName("fields[$field_name][settings_edit_form][settings][auto_create_bundle]"); + + // Go to field settings and enable the second vocabulary. + $field_settings_path = 'admin/structure/types/manage/' . $this->type . '/fields/' . $field_id; + $edit = [ + 'settings[handler_settings][target_bundles][' . $vocabularies[1]->id() . ']' => TRUE, + ]; + $this->drupalPostForm($field_settings_path, $edit, t('Save settings')); + + // Go back to widget settings. + $this->drupalPostAjaxForm($form_display_path, [], $triggering_element); + + $this->assertFieldByXPath("//select[@name='fields[$field_name][settings_edit_form][settings][auto_create_bundle]']/option[@value='" . $vocabularies[0]->id() . "']"); + $this->assertFieldByXPath("//select[@name='fields[$field_name][settings_edit_form][settings][auto_create_bundle]']/option[@value='" . $vocabularies[1]->id() . "']"); + + $edit = [ + "fields[$field_name][settings_edit_form][settings][auto_create]" => TRUE, + "fields[$field_name][settings_edit_form][settings][auto_create_bundle]" => $vocabularies[1]->id(), + ]; + $this->drupalPostForm(NULL, $edit, t('Update')); + // Submit also the main form. + $this->drupalPostForm(NULL, [], t('Save')); + + /** @var \Drupal\Core\Entity\Display\EntityDisplayInterface $form_display */ + $form_display = EntityFormDisplay::load("node.{$this->type}.default"); + $settings = $form_display->getComponent($field_name)['settings']; + + // Expect that the target bundle has been saved in the backend. + $this->assertEqual($settings['auto_create_bundle'], $vocabularies[1]->id()); + + // Delete the other bundle. Field config should not be affected. + $vocabularies[0]->delete(); + $form_display = EntityFormDisplay::load("node.{$this->type}.default"); + $settings = $form_display->getComponent($field_name)['settings']; + $this->assertTrue($settings['auto_create']); + $this->assertIdentical($settings['auto_create_bundle'], $vocabularies[1]->id()); + + // Delete the bundle set for entity auto-creation. Auto-created settings + // should be reset (no auto-creation). + // @todo Implement this once https://www.drupal.org/node/2553169 is in. + //$vocabularies[1]->delete(); + //$form_display = EntityFormDisplay::load("node.{$this->type}.default"); + //$settings = $form_display->getComponent($field_name)['settings']; + //$this->assertFalse($settings['auto_create']); + //$this->assertNull($settings['auto_create_bundle']); + } + + /** * Creates a new Entity Reference fields with a given target type. * - * @param $target_type + * @param string $target_type * The name of the target type - * @param $bundle - * Name of the bundle - * Default = NULL + * @param string[] $bundles + * A list of bundle IDs. Defaults to []. + * * @return string * Returns the generated field name */ - public function createEntityReferenceField($target_type, $bundle = NULL) { + protected function createEntityReferenceField($target_type, $bundles = []) { // Generates a bundle path for the newly created content type. $bundle_path = 'admin/structure/types/manage/' . $this->type; @@ -381,7 +460,7 @@ public function createEntityReferenceField($target_type, $bundle = NULL) { $storage_edit = $field_edit = array(); $storage_edit['settings[target_type]'] = $target_type; - if ($bundle) { + foreach ($bundles as $bundle) { $field_edit['settings[handler_settings][target_bundles][' . $bundle . ']'] = TRUE; } @@ -391,7 +470,6 @@ public function createEntityReferenceField($target_type, $bundle = NULL) { return $field_name; } - /** * Checks if a select element contains the specified options. * diff --git a/core/modules/entity_reference/src/Tests/EntityReferenceAutoCreateTest.php b/core/modules/entity_reference/src/Tests/EntityReferenceAutoCreateTest.php index dc87dc8..36364ca 100644 --- a/core/modules/entity_reference/src/Tests/EntityReferenceAutoCreateTest.php +++ b/core/modules/entity_reference/src/Tests/EntityReferenceAutoCreateTest.php @@ -7,7 +7,10 @@ namespace Drupal\entity_reference\Tests; +use Drupal\Component\Utility\Unicode; use Drupal\Core\Field\FieldStorageDefinitionInterface; +use Drupal\field\Entity\FieldConfig; +use Drupal\taxonomy\Entity\Vocabulary; use Drupal\simpletest\WebTestBase; use Drupal\node\Entity\Node; @@ -18,7 +21,9 @@ */ class EntityReferenceAutoCreateTest extends WebTestBase { - public static $modules = array('entity_reference', 'node'); + use EntityReferenceTestTrait; + + public static $modules = ['entity_reference', 'node', 'taxonomy']; /** * The name of a content type that will reference $referencedType. @@ -68,8 +73,6 @@ protected function setUp() { 'target_bundles' => array( $referenced->id(), ), - // Enable auto-create. - 'auto_create' => TRUE, ), ), ))->save(); @@ -80,8 +83,12 @@ protected function setUp() { entity_get_form_display('node', $referencing->id(), 'default') ->setComponent('test_field', array( 'type' => 'entity_reference_autocomplete', + 'settings' => array('auto_create' => TRUE), )) ->save(); + + $account = $this->drupalCreateUser(['access content', "create $this->referencingType content"]); + $this->drupalLogin($account); } /** @@ -89,9 +96,6 @@ protected function setUp() { * entity. */ public function testAutoCreate() { - $user1 = $this->drupalCreateUser(array('access content', "create $this->referencingType content")); - $this->drupalLogin($user1); - $this->drupalGet('node/add/' . $this->referencingType); $this->assertFieldByXPath('//input[@id="edit-test-field-0-target-id" and contains(@class, "form-autocomplete")]', NULL, 'The autocomplete input element appears.'); @@ -134,4 +138,110 @@ public function testAutoCreate() { $this->assertText($referencing_node->label(), 'Referencing node label found.'); $this->assertText($referenced_node->label(), 'Referenced node label found.'); } + + /** + * Tests if a entity reference field having multiple target bundles is storing + * the auto-created entity in the right destination. + */ + public function testMultipleTargetBundles() { + /** @var \Drupal\Core\Config\ConfigFactoryInterface $factory */ + $factory = $this->container->get('config.factory'); + + /** @var \Drupal\taxonomy\Entity\Vocabulary[] $vocabularies */ + $vocabularies = []; + for ($i = 0; $i < 2; $i++) { + $vid = Unicode::strtolower($this->randomMachineName()); + $vocabularies[$i] = Vocabulary::create([ + 'name' => $this->randomMachineName(), + 'vid' => $vid, + ]); + $vocabularies[$i]->save(); + } + + // Create a taxonomy term entity reference field that saves the auto-created + // taxonomy terms in the second vocabulary from the two that were configured + // as targets. + $field_name = Unicode::strtolower($this->randomMachineName()); + $handler_settings = [ + 'target_bundles' => [ + $vocabularies[0]->id() => $vocabularies[0]->id(), + $vocabularies[1]->id() => $vocabularies[1]->id(), + ], + ]; + $this->createEntityReferenceField('node', $this->referencingType, $field_name, $this->randomString(), 'taxonomy_term', 'default', $handler_settings); + /** @var \Drupal\Core\Entity\Display\EntityFormDisplayInterface $fd */ + entity_get_form_display('node', $this->referencingType, 'default') + ->setComponent($field_name, [ + 'type' => 'entity_reference_autocomplete', + 'settings' => [ + 'auto_create' => TRUE, + 'auto_create_bundle' => $vocabularies[1]->id(), + ], + ]) + ->save(); + + $term_name = $this->randomString(); + $edit = [ + $field_name . '[0][target_id]' => $term_name, + 'title[0][value]' => $this->randomString(), + ]; + + $this->drupalPostForm('node/add/' . $this->referencingType, $edit, 'Save'); + /** @var \Drupal\taxonomy\Entity\Term $term */ + $term = taxonomy_term_load_multiple_by_name($term_name); + $term = reset($term); + + // The new term is expected to be stored in the second vocabulary. + $this->assertEqual($vocabularies[1]->id(), $term->bundle()); + + /** @var \Drupal\field\Entity\FieldConfig $field_config */ + $field_config = FieldConfig::loadByName('node', $this->referencingType, $field_name); + $handler_settings = $field_config->getSetting('handler_settings'); + + // Change the field setting to store the auto-created terms in the first + // vocabulary and test again. + $factory->getEditable("core.entity_form_display.node.{$this->referencingType}.default") + ->set("content.$field_name.settings.auto_create_bundle", $vocabularies[0]->id()) + ->save(); + + $term_name = $this->randomString(); + $edit = [ + $field_name . '[0][target_id]' => $term_name, + 'title[0][value]' => $this->randomString(), + ]; + + $this->drupalPostForm('node/add/' . $this->referencingType, $edit, 'Save'); + /** @var \Drupal\taxonomy\Entity\Term $term */ + $term = taxonomy_term_load_multiple_by_name($term_name); + $term = reset($term); + + // The second term is expected to be stored in the first vocabulary. + $this->assertEqual($vocabularies[0]->id(), $term->bundle()); + + // Test the case when the field config settings are inconsistent. + $factory->getEditable("core.entity_form_display.node.{$this->referencingType}.default") + ->clear("content.$field_name.settings.auto_create_bundle") + ->save(TRUE); + + // If we use $this->drupalGet() we cannot catch the exception because the + // form builder runs in other PHP space. Instead we are only building the + // form in order to check if the exception is thrown. + try { + /** @var \Drupal\Core\Form\FormBuilderInterface $form_builder */ + $form_builder = $this->container->get('entity.form_builder'); + $form_builder->getForm(Node::load(1)); + $this->fail("Missed 'auto_create_bundle' should throw \\InvalidArgumentException but it didn't."); + } + catch (\InvalidArgumentException $e) { + $this->assertIdentical( + $e->getMessage(), + sprintf( + "Create referenced entities if they don't already exist option is enabled but a specific destination bundle is not set. You should re-visit 'Manage form display' and fix the widget settings of the '%s' (%s) field.", + $field_config->getLabel(), + $field_config->getName() + ) + ); + } + } + } diff --git a/core/modules/rdf/src/Tests/EntityReferenceFieldAttributesTest.php b/core/modules/rdf/src/Tests/EntityReferenceFieldAttributesTest.php index 52c4e86..0890af3 100644 --- a/core/modules/rdf/src/Tests/EntityReferenceFieldAttributesTest.php +++ b/core/modules/rdf/src/Tests/EntityReferenceFieldAttributesTest.php @@ -51,7 +51,6 @@ protected function setUp() { 'target_bundles' => array( $this->vocabulary->id() => $this->vocabulary->id(), ), - 'auto_create' => TRUE, ); $this->createEntityReferenceField('node', 'article', $this->fieldName, 'Tags', 'taxonomy_term', 'default', $handler_settings, FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED); diff --git a/core/modules/taxonomy/src/Plugin/EntityReferenceSelection/TermSelection.php b/core/modules/taxonomy/src/Plugin/EntityReferenceSelection/TermSelection.php index ddf99ca..7c62d8c 100644 --- a/core/modules/taxonomy/src/Plugin/EntityReferenceSelection/TermSelection.php +++ b/core/modules/taxonomy/src/Plugin/EntityReferenceSelection/TermSelection.php @@ -38,21 +38,13 @@ public function entityQueryAlter(SelectInterface $query) { */ public function buildConfigurationForm(array $form, FormStateInterface $form_state) { $form = parent::buildConfigurationForm($form, $form_state); - $form['target_bundles']['#title'] = $this->t('Vocabularies'); - // @todo: Currently allow auto-create only on taxonomy terms. - $form['auto_create'] = array( - '#type' => 'checkbox', - '#title' => $this->t("Create referenced entities if they don't already exist"), - '#default_value' => isset($this->configuration['handler_settings']['auto_create']) ? $this->configuration['handler_settings']['auto_create'] : FALSE, - ); // Sorting is not possible for taxonomy terms because we use // \Drupal\taxonomy\TermStorageInterface::loadTree() to retrieve matches. $form['sort']['#access'] = FALSE; return $form; - } /**