public function FieldUiTestTrait::fieldUIAddExistingField in Drupal 10

Same name and namespace in other branches

1. 8 core/modules/field_ui/tests/src/Traits/FieldUiTestTrait.php \Drupal\Tests\field_ui\Traits\FieldUiTestTrait::fieldUIAddExistingField()
2. 9 core/modules/field_ui/tests/src/Traits/FieldUiTestTrait.php \Drupal\Tests\field_ui\Traits\FieldUiTestTrait::fieldUIAddExistingField()

Adds an existing field through the Field UI.

Parameters

string $bundle_path: Admin path of the bundle that the field is to be attached to.

string $existing_storage_name: The name of the existing field storage for which we want to add a new field.

string $label: (optional) The label of the new field. Defaults to a random string.

array $field_edit: (optional) $edit parameter for submitForm() on the second step ('Field settings' form).

File

core/modules/field_ui/tests/src/Traits/FieldUiTestTrait.php, line 84

Class

FieldUiTestTrait

Provides common functionality for the Field UI test classes.

Namespace

Drupal\Tests\field_ui\Traits

Code

public function fieldUIAddExistingField($bundle_path, $existing_storage_name, $label = NULL, array $field_edit = []) {
  $label = $label ?: $this
    ->randomMachineName();
  $initial_edit = [
    'existing_storage_name' => $existing_storage_name,
    'existing_storage_label' => $label,
  ];

  // First step: 'Re-use existing field' on the 'Add field' page.
  $this
    ->drupalGet("{$bundle_path}/fields/add-field");
  $this
    ->submitForm($initial_edit, 'Save and continue');

  // Set the main content to only the content region because the label can
  // contain HTML which will be auto-escaped by Twig.
  $this
    ->assertSession()
    ->responseContains('field-config-edit-form');

  // Check that the page does not have double escaped HTML tags.
  $this
    ->assertSession()
    ->responseNotContains('<');

  // Second step: 'Field settings' form.
  $this
    ->submitForm($field_edit, 'Save settings');
  $this
    ->assertSession()
    ->pageTextContains("Saved {$label} configuration.");

  // Check that the field appears in the overview form.
  $xpath = $this
    ->assertSession()
    ->buildXPathQuery("//table[@id=\"field-overview\"]//tr/td[1 and text() = :label]", [
    ':label' => $label,
  ]);
  $this
    ->assertSession()
    ->elementExists('xpath', $xpath);
}