EntityReferenceAutoCreateTest.php 8.31 KB
Newer Older
1 2
<?php

3
namespace Drupal\Tests\field\Functional\EntityReference;
4

5
use Drupal\Core\Field\FieldStorageDefinitionInterface;
6
use Drupal\field\Entity\FieldConfig;
7
use Drupal\Tests\BrowserTestBase;
8
use Drupal\Tests\field\Traits\EntityReferenceTestTrait;
9
use Drupal\taxonomy\Entity\Vocabulary;
10
use Drupal\node\Entity\Node;
11
use Drupal\field\Entity\FieldStorageConfig;
12 13

/**
14 15 16
 * Tests creating new entity (e.g. taxonomy-term) from an autocomplete widget.
 *
 * @group entity_reference
17
 */
18
class EntityReferenceAutoCreateTest extends BrowserTestBase {
19

20 21
  use EntityReferenceTestTrait;

22
  public static $modules = ['node', 'taxonomy'];
23

24 25 26 27 28
  /**
   * {@inheritdoc}
   */
  protected $defaultTheme = 'stark';

29 30 31 32 33 34 35 36 37 38 39 40 41 42
  /**
   * The name of a content type that will reference $referencedType.
   *
   * @var string
   */
  protected $referencingType;

  /**
   * The name of a content type that will be referenced by $referencingType.
   *
   * @var string
   */
  protected $referencedType;

43
  protected function setUp() {
44 45 46 47
    parent::setUp();

    // Create "referencing" and "referenced" node types.
    $referencing = $this->drupalCreateContentType();
48
    $this->referencingType = $referencing->id();
49 50

    $referenced = $this->drupalCreateContentType();
51
    $this->referencedType = $referenced->id();
52

53
    FieldStorageConfig::create([
54
      'field_name' => 'test_field',
55
      'entity_type' => 'node',
56
      'translatable' => FALSE,
57 58
      'entity_types' => [],
      'settings' => [
59
        'target_type' => 'node',
60
      ],
61
      'type' => 'entity_reference',
62
      'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
63
    ])->save();
64

65
    FieldConfig::create([
66 67 68
      'label' => 'Entity reference field',
      'field_name' => 'test_field',
      'entity_type' => 'node',
69
      'bundle' => $referencing->id(),
70
      'settings' => [
71
        'handler' => 'default',
72
        'handler_settings' => [
73
          // Reference a single vocabulary.
74
          'target_bundles' => [
75
            $referenced->id(),
76
          ],
77 78
          // Enable auto-create.
          'auto_create' => TRUE,
79 80
        ],
      ],
81
    ])->save();
82

83 84 85 86
    /** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */
    $display_repository = \Drupal::service('entity_display.repository');

    $display_repository->getViewDisplay('node', $referencing->id())
87 88
      ->setComponent('test_field')
      ->save();
89
    $display_repository->getFormDisplay('node', $referencing->id(), 'default')
90
      ->setComponent('test_field', [
91
        'type' => 'entity_reference_autocomplete',
92
      ])
93
      ->save();
94 95 96

    $account = $this->drupalCreateUser(['access content', "create $this->referencingType content"]);
    $this->drupalLogin($account);
97 98 99
  }

  /**
100 101
   * Tests that the autocomplete input element appears and the creation of a new
   * entity.
102 103
   */
  public function testAutoCreate() {
104
    $this->drupalGet('node/add/' . $this->referencingType);
105 106
    $this->assertFieldByXPath('//input[@id="edit-test-field-0-target-id" and contains(@class, "form-autocomplete")]', NULL, 'The autocomplete input element appears.');

107
    $new_title = $this->randomMachineName();
108 109

    // Assert referenced node does not exist.
110
    $base_query = \Drupal::entityQuery('node');
111
    $base_query
112
      ->condition('type', $this->referencedType)
113 114 115 116 117 118
      ->condition('title', $new_title);

    $query = clone $base_query;
    $result = $query->execute();
    $this->assertFalse($result, 'Referenced node does not exist yet.');

119
    $edit = [
120
      'title[0][value]' => $this->randomMachineName(),
121
      'test_field[0][target_id]' => $new_title,
122
    ];
123
    $this->drupalPostForm("node/add/$this->referencingType", $edit, 'Save');
124 125 126 127 128 129

    // Assert referenced node was created.
    $query = clone $base_query;
    $result = $query->execute();
    $this->assertTrue($result, 'Referenced node was created.');
    $referenced_nid = key($result);
130
    $referenced_node = Node::load($referenced_nid);
131 132

    // Assert the referenced node is associated with referencing node.
133
    $result = \Drupal::entityQuery('node')
134
      ->condition('type', $this->referencingType)
135 136 137
      ->execute();

    $referencing_nid = key($result);
138
    $referencing_node = Node::load($referencing_nid);
139
    $this->assertEqual($referenced_nid, $referencing_node->test_field->target_id, 'Newly created node is referenced from the referencing node.');
140 141 142 143 144

    // Now try to view the node and check that the referenced node is shown.
    $this->drupalGet('node/' . $referencing_node->id());
    $this->assertText($referencing_node->label(), 'Referencing node label found.');
    $this->assertText($referenced_node->label(), 'Referenced node label found.');
145
  }
146 147 148 149 150 151 152 153 154

  /**
   * Tests if an entity reference field having multiple target bundles is
   * storing the auto-created entity in the right destination.
   */
  public function testMultipleTargetBundles() {
    /** @var \Drupal\taxonomy\Entity\Vocabulary[] $vocabularies */
    $vocabularies = [];
    for ($i = 0; $i < 2; $i++) {
155
      $vid = mb_strtolower($this->randomMachineName());
156 157 158 159 160 161 162 163 164 165
      $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.
166
    $field_name = mb_strtolower($this->randomMachineName());
167 168 169 170 171 172 173 174 175 176
    $handler_settings = [
      'target_bundles' => [
        $vocabularies[0]->id() => $vocabularies[0]->id(),
        $vocabularies[1]->id() => $vocabularies[1]->id(),
      ],
      'auto_create' => TRUE,
      'auto_create_bundle' => $vocabularies[1]->id(),
    ];
    $this->createEntityReferenceField('node', $this->referencingType, $field_name, $this->randomString(), 'taxonomy_term', 'default', $handler_settings);
    /** @var \Drupal\Core\Entity\Display\EntityFormDisplayInterface $fd */
177 178
    \Drupal::service('entity_display.repository')
      ->getFormDisplay('node', $this->referencingType)
179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223
      ->setComponent($field_name, ['type' => 'entity_reference_autocomplete'])
      ->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.
    $handler_settings['auto_create_bundle'] = $vocabularies[0]->id();
    $field_config->setSetting('handler_settings', $handler_settings);
    $field_config->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());

    // @todo Re-enable this test when WebTestBase::curlHeaderCallback() provides
    //   a way to catch and assert user-triggered errors.

    // Test the case when the field config settings are inconsistent.
224 225 226
    // unset($handler_settings['auto_create_bundle']);
    // $field_config->setSetting('handler_settings', $handler_settings);
    // $field_config->save();
227
    //
228 229
    // $this->drupalGet('node/add/' . $this->referencingType);
    // $error_message = sprintf(
230 231 232
    //  "Create referenced entities if they don't already exist option is enabled but a specific destination bundle is not set. You should re-visit and fix the settings of the '%s' (%s) field.",
    //  $field_config->getLabel(),
    //  $field_config->getName()
233 234
    // );
    // $this->assertErrorLogged($error_message);
235 236
  }

237
}