You are here

Home » API reference » Zircon Profile 8 » EntityReferenceAdminTest.php » EntityReferenceAdminTest

public function EntityReferenceAdminTest::testFieldAdminHandler in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 core/modules/field/src/Tests/EntityReference/EntityReferenceAdminTest.php \Drupal\field\Tests\EntityReference\EntityReferenceAdminTest::testFieldAdminHandler()

Tests the Entity Reference Admin UI.

File

core/modules/field/src/Tests/EntityReference/EntityReferenceAdminTest.php, line 70
Contains \Drupal\field\Tests\EntityReference\EntityReferenceAdminTest.

Class

EntityReferenceAdminTest
Tests for the administrative UI.

Namespace

Drupal\field\Tests\EntityReference

Code

public function testFieldAdminHandler() {
  $bundle_path = 'admin/structure/types/manage/' . $this->type;

  // First step: 'Add new field' on the 'Manage fields' page.
  $this
    ->drupalGet($bundle_path . '/fields/add-field');

  // Check if the commonly referenced entity types appear in the list.
  $this
    ->assertOption('edit-new-storage-type', 'field_ui:entity_reference:node');
  $this
    ->assertOption('edit-new-storage-type', 'field_ui:entity_reference:user');
  $this
    ->drupalPostForm(NULL, array(
    'label' => 'Test label',
    'field_name' => 'test',
    'new_storage_type' => 'entity_reference',
  ), t('Save and continue'));

  // Node should be selected by default.
  $this
    ->assertFieldByName('settings[target_type]', 'node');

  // Check that all entity types can be referenced.
  $this
    ->assertFieldSelectOptions('settings[target_type]', array_keys(\Drupal::entityManager()
    ->getDefinitions()));

  // Second step: 'Field settings' form.
  $this
    ->drupalPostForm(NULL, array(), t('Save field settings'));

  // The base handler should be selected by default.
  $this
    ->assertFieldByName('settings[handler]', 'default:node');

  // The base handler settings should be displayed.
  $entity_type_id = 'node';
  $bundles = entity_get_bundles($entity_type_id);
  foreach ($bundles as $bundle_name => $bundle_info) {
    $this
      ->assertFieldByName('settings[handler_settings][target_bundles][' . $bundle_name . ']');
  }
  reset($bundles);

  // Test the sort settings.
  // Option 0: no sort.
  $this
    ->assertFieldByName('settings[handler_settings][sort][field]', '_none');
  $this
    ->assertNoFieldByName('settings[handler_settings][sort][direction]');

  // Option 1: sort by field.
  $this
    ->drupalPostAjaxForm(NULL, array(
    'settings[handler_settings][sort][field]' => 'nid',
  ), 'settings[handler_settings][sort][field]');
  $this
    ->assertFieldByName('settings[handler_settings][sort][direction]', 'ASC');

  // Test that a non-translatable base field is a sort option.
  $this
    ->assertFieldByXPath("//select[@name='settings[handler_settings][sort][field]']/option[@value='nid']");

  // Test that a translatable base field is a sort option.
  $this
    ->assertFieldByXPath("//select[@name='settings[handler_settings][sort][field]']/option[@value='title']");

  // Test that a configurable field is a sort option.
  $this
    ->assertFieldByXPath("//select[@name='settings[handler_settings][sort][field]']/option[@value='body.value']");

  // Set back to no sort.
  $this
    ->drupalPostAjaxForm(NULL, array(
    'settings[handler_settings][sort][field]' => '_none',
  ), 'settings[handler_settings][sort][field]');
  $this
    ->assertNoFieldByName('settings[handler_settings][sort][direction]');

  // Third step: confirm.
  $this
    ->drupalPostForm(NULL, array(
    'required' => '1',
    'settings[handler_settings][target_bundles][' . key($bundles) . ']' => key($bundles),
  ), t('Save settings'));

  // Check that the field appears in the overview form.
  $this
    ->assertFieldByXPath('//table[@id="field-overview"]//tr[@id="field-test"]/td[1]', 'Test label', 'Field was created and appears in the overview page.');

  // Check that the field settings form can be submitted again, even when the
  // field is required.
  // The first 'Edit' link is for the Body field.
  $this
    ->clickLink(t('Edit'), 1);
  $this
    ->drupalPostForm(NULL, array(), t('Save settings'));

  // Switch the target type to 'taxonomy_term' and check that the settings
  // specific to its selection handler are displayed.
  $field_name = 'node.' . $this->type . '.field_test';
  $edit = array(
    'settings[target_type]' => 'taxonomy_term',
  );
  $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.
  $field_name = 'node.' . $this->type . '.field_test';
  $edit = array(
    'settings[target_type]' => 'user',
  );
  $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][filter][type]', '_none');

  // Switch the target type to 'node'.
  $field_name = 'node.' . $this->type . '.field_test';
  $edit = array(
    'settings[target_type]' => 'node',
  );
  $this
    ->drupalPostForm($bundle_path . '/fields/' . $field_name . '/storage', $edit, t('Save field settings'));

  // Try to select the views handler.
  $edit = array(
    'settings[handler]' => 'views',
  );
  $this
    ->drupalPostAjaxForm($bundle_path . '/fields/' . $field_name, $edit, 'settings[handler]');
  $this
    ->assertRaw(t('No eligible views were found. <a href=":create">Create a view</a> with an <em>Entity Reference</em> display, or add such a display to an <a href=":existing">existing view</a>.', array(
    ':create' => \Drupal::url('views_ui.add'),
    ':existing' => \Drupal::url('entity.view.collection'),
  )));
  $this
    ->drupalPostForm(NULL, $edit, t('Save settings'));

  // If no eligible view is available we should see a message.
  $this
    ->assertText('The views entity selection mode requires a view.');

  // Enable the entity_reference_test module which creates an eligible view.
  $this->container
    ->get('module_installer')
    ->install(array(
    'entity_reference_test',
  ));
  $this
    ->resetAll();
  $this
    ->drupalGet($bundle_path . '/fields/' . $field_name);
  $this
    ->drupalPostAjaxForm($bundle_path . '/fields/' . $field_name, $edit, 'settings[handler]');
  $edit = array(
    'settings[handler_settings][view][view_and_display]' => 'test_entity_reference:entity_reference_1',
  );
  $this
    ->drupalPostForm(NULL, $edit, t('Save settings'));
  $this
    ->assertResponse(200);

  // Switch the target type to 'entity_test'.
  $edit = array(
    'settings[target_type]' => 'entity_test',
  );
  $this
    ->drupalPostForm($bundle_path . '/fields/' . $field_name . '/storage', $edit, t('Save field settings'));
  $this
    ->drupalGet($bundle_path . '/fields/' . $field_name);
  $edit = array(
    'settings[handler]' => 'views',
  );
  $this
    ->drupalPostAjaxForm($bundle_path . '/fields/' . $field_name, $edit, 'settings[handler]');
  $edit = array(
    'required' => FALSE,
    'settings[handler_settings][view][view_and_display]' => 'test_entity_reference_entity_test:entity_reference_1',
  );
  $this
    ->drupalPostForm(NULL, $edit, t('Save settings'));
  $this
    ->assertResponse(200);

  // Create a new view and display it as a entity reference.
  $edit = array(
    'id' => 'node_test_view',
    'label' => 'Node Test View',
    'show[wizard_key]' => 'node',
    'page[create]' => 1,
    'page[title]' => 'Test Node View',
    'page[path]' => 'test/node/view',
    'page[style][style_plugin]' => 'default',
    'page[style][row_plugin]' => 'fields',
  );
  $this
    ->drupalPostForm('admin/structure/views/add', $edit, t('Save and edit'));
  $this
    ->drupalPostForm(NULL, array(), t('Duplicate as Entity Reference'));
  $this
    ->clickLink(t('Settings'));
  $edit = array(
    'style_options[search_fields][title]' => 'title',
  );
  $this
    ->drupalPostForm(NULL, $edit, t('Apply'));
  $this
    ->drupalPostForm('admin/structure/views/view/node_test_view/edit/entity_reference_1', array(), t('Save'));
  $this
    ->clickLink(t('Settings'));

  // Create a test entity reference field.
  $field_name = 'test_entity_ref_field';
  $edit = array(
    'new_storage_type' => 'field_ui:entity_reference:node',
    'label' => 'Test Entity Reference Field',
    'field_name' => $field_name,
  );
  $this
    ->drupalPostForm($bundle_path . '/fields/add-field', $edit, t('Save and continue'));
  $this
    ->drupalPostForm(NULL, array(), t('Save field settings'));

  // Add the view to the test field.
  $edit = array(
    'settings[handler]' => 'views',
  );
  $this
    ->drupalPostAjaxForm(NULL, $edit, 'settings[handler]');
  $edit = array(
    'required' => FALSE,
    'settings[handler_settings][view][view_and_display]' => 'node_test_view:entity_reference_1',
  );
  $this
    ->drupalPostForm(NULL, $edit, t('Save settings'));

  // Create nodes.
  $node1 = Node::create([
    'type' => $this->type,
    'title' => 'Foo Node',
  ]);
  $node1
    ->save();
  $node2 = Node::create([
    'type' => $this->type,
    'title' => 'Foo Node',
  ]);
  $node2
    ->save();

  // Try to add a new node and fill the entity reference field.
  $this
    ->drupalGet('node/add/' . $this->type);
  $result = $this
    ->xpath('//input[@name="field_test_entity_ref_field[0][target_id]" and contains(@data-autocomplete-path, "/entity_reference_autocomplete/node/views/")]');
  $target_url = $this
    ->getAbsoluteUrl($result[0]['data-autocomplete-path']);
  $this
    ->drupalGet($target_url, array(
    'query' => array(
      'q' => 'Foo',
    ),
  ));
  $this
    ->assertRaw($node1
    ->getTitle() . ' (' . $node1
    ->id() . ')');
  $this
    ->assertRaw($node2
    ->getTitle() . ' (' . $node2
    ->id() . ')');
  $edit = array(
    'title[0][value]' => 'Example',
    'field_test_entity_ref_field[0][target_id]' => 'Test',
  );
  $this
    ->drupalPostForm('node/add/' . $this->type, $edit, t('Save'));

  // Assert that entity reference autocomplete field is validated.
  $this
    ->assertText(t('There are no entities matching "@entity"', [
    '@entity' => 'Test',
  ]));
  $edit = array(
    'title[0][value]' => 'Test',
    'field_test_entity_ref_field[0][target_id]' => $node1
      ->getTitle(),
  );
  $this
    ->drupalPostForm('node/add/' . $this->type, $edit, t('Save'));

  // Assert the results multiple times to avoid sorting problem of nodes with
  // the same title.
  $this
    ->assertText(t('Multiple entities match this reference;'));
  $this
    ->assertText(t("@node1", [
    '@node1' => $node1
      ->getTitle() . ' (' . $node1
      ->id() . ')',
  ]));
  $this
    ->assertText(t("@node2", [
    '@node2' => $node2
      ->getTitle() . ' (' . $node2
      ->id() . ')',
  ]));
  $edit = array(
    'title[0][value]' => 'Test',
    'field_test_entity_ref_field[0][target_id]' => $node1
      ->getTitle() . '(' . $node1
      ->id() . ')',
  );
  $this
    ->drupalPostForm('node/add/' . $this->type, $edit, t('Save'));
  $this
    ->assertLink($node1
    ->getTitle());

  // Tests adding default values to autocomplete widgets.
  Vocabulary::create(array(
    'vid' => 'tags',
    'name' => 'tags',
  ))
    ->save();
  $taxonomy_term_field_name = $this
    ->createEntityReferenceField('taxonomy_term', 'tags');
  $field_path = 'node.' . $this->type . '.field_' . $taxonomy_term_field_name;
  $this
    ->drupalGet($bundle_path . '/fields/' . $field_path . '/storage');
  $edit = [
    'cardinality' => -1,
  ];
  $this
    ->drupalPostForm(NULL, $edit, t('Save field settings'));
  $this
    ->drupalGet($bundle_path . '/fields/' . $field_path);
  $term_name = $this
    ->randomString();
  $edit = [
    // This must be set before new entities will be auto-created.
    'settings[handler_settings][auto_create]' => 1,
  ];
  $this
    ->drupalPostForm(NULL, $edit, t('Save settings'));
  $this
    ->drupalGet($bundle_path . '/fields/' . $field_path);
  $edit = [
    // A term that doesn't yet exist.
    'default_value_input[field_' . $taxonomy_term_field_name . '][0][target_id]' => $term_name,
  ];
  $this
    ->drupalPostForm(NULL, $edit, t('Save settings'));

  // The term should now exist.
  $term = taxonomy_term_load_multiple_by_name($term_name, 'tags')[1];
  $this
    ->assertIdentical(1, count($term), 'Taxonomy term was auto created when set as field default.');
}