class FormTest in Drupal 9
Same name in this branch
- 9 core/modules/field/tests/src/Functional/FormTest.php \Drupal\Tests\field\Functional\FormTest
- 9 core/modules/system/tests/src/Functional/Form/FormTest.php \Drupal\Tests\system\Functional\Form\FormTest
Same name and namespace in other branches
- 8 core/modules/field/tests/src/Functional/FormTest.php \Drupal\Tests\field\Functional\FormTest
Tests field form handling.
@group field
Hierarchy
- class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, FunctionalTestSetupTrait, TestSetupTrait, AssertLegacyTrait, BlockCreationTrait, ConfigTestTrait, ExtensionListTestTrait, ContentTypeCreationTrait, NodeCreationTrait, PhpUnitCompatibilityTrait, RandomGeneratorTrait, TestRequirementsTrait, PhpUnitWarnings, UiHelperTrait, UserCreationTrait, XdebugRequestTrait
- class \Drupal\Tests\field\Functional\FieldTestBase
- class \Drupal\Tests\field\Functional\FormTest
- class \Drupal\Tests\field\Functional\FieldTestBase
Expanded class hierarchy of FormTest
File
- core/
modules/ field/ tests/ src/ Functional/ FormTest.php, line 19
Namespace
Drupal\Tests\field\FunctionalView source
class FormTest extends FieldTestBase {
/**
* Modules to enable.
*
* Locale is installed so that TranslatableMarkup actually does something.
*
* @var array
*/
protected static $modules = [
'node',
'field_test',
'options',
'entity_test',
'locale',
];
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* An array of values defining a field single.
*
* @var array
*/
protected $fieldStorageSingle;
/**
* An array of values defining a field multiple.
*
* @var array
*/
protected $fieldStorageMultiple;
/**
* An array of values defining a field with unlimited cardinality.
*
* @var array
*/
protected $fieldStorageUnlimited;
/**
* An array of values defining a field.
*
* @var array
*/
protected $field;
protected function setUp() : void {
parent::setUp();
$web_user = $this
->drupalCreateUser([
'view test entity',
'administer entity_test content',
]);
$this
->drupalLogin($web_user);
$this->fieldStorageSingle = [
'field_name' => 'field_single',
'entity_type' => 'entity_test',
'type' => 'test_field',
];
$this->fieldStorageMultiple = [
'field_name' => 'field_multiple',
'entity_type' => 'entity_test',
'type' => 'test_field',
'cardinality' => 4,
];
$this->fieldStorageUnlimited = [
'field_name' => 'field_unlimited',
'entity_type' => 'entity_test',
'type' => 'test_field',
'cardinality' => FieldStorageDefinitionInterface::CARDINALITY_UNLIMITED,
];
$this->field = [
'entity_type' => 'entity_test',
'bundle' => 'entity_test',
'label' => $this
->randomMachineName() . '_label',
'description' => '[site:name]_description',
'weight' => mt_rand(0, 127),
'settings' => [
'test_field_setting' => $this
->randomMachineName(),
],
];
}
public function testFieldFormSingle() {
$field_storage = $this->fieldStorageSingle;
$field_name = $field_storage['field_name'];
$this->field['field_name'] = $field_name;
FieldStorageConfig::create($field_storage)
->save();
FieldConfig::create($this->field)
->save();
\Drupal::service('entity_display.repository')
->getFormDisplay($this->field['entity_type'], $this->field['bundle'])
->setComponent($field_name)
->save();
// Display creation form.
$this
->drupalGet('entity_test/add');
// Create token value expected for description.
$token_description = Html::escape($this
->config('system.site')
->get('name')) . '_description';
$this
->assertSession()
->pageTextContains($token_description);
$this
->assertSession()
->fieldValueEquals("{$field_name}[0][value]", '');
// Verify that no extraneous widget is displayed.
$this
->assertSession()
->fieldNotExists("{$field_name}[1][value]");
// Check that hook_field_widget_single_element_form_alter() does not believe
// this is the default value form.
$this
->assertSession()
->pageTextNotContains('From hook_field_widget_single_element_form_alter(): Default form is true.');
// Check that hook_field_widget_single_element_form_alter() does not believe
// this is the default value form.
$this
->assertSession()
->pageTextNotContains('From hook_field_widget_complete_form_alter(): Default form is true.');
// Submit with invalid value (field-level validation).
$edit = [
"{$field_name}[0][value]" => -1,
];
$this
->submitForm($edit, 'Save');
$this
->assertSession()
->pageTextContains("{$this->field['label']} does not accept the value -1.");
// TODO : check that the correct field is flagged for error.
// Create an entity
$value = mt_rand(1, 127);
$edit = [
"{$field_name}[0][value]" => $value,
];
$this
->submitForm($edit, 'Save');
preg_match('|entity_test/manage/(\\d+)|', $this
->getUrl(), $match);
$id = $match[1];
$this
->assertSession()
->pageTextContains('entity_test ' . $id . ' has been created.');
$entity = EntityTest::load($id);
$this
->assertEquals($value, $entity->{$field_name}->value, 'Field value was saved');
// Display edit form.
$this
->drupalGet('entity_test/manage/' . $id . '/edit');
// Check that the widget is displayed with the correct default value.
$this
->assertSession()
->fieldValueEquals("{$field_name}[0][value]", $value);
// Verify that no extraneous widget is displayed.
$this
->assertSession()
->fieldNotExists("{$field_name}[1][value]");
// Update the entity.
$value = mt_rand(1, 127);
$edit = [
"{$field_name}[0][value]" => $value,
];
$this
->submitForm($edit, 'Save');
$this
->assertSession()
->pageTextContains('entity_test ' . $id . ' has been updated.');
$this->container
->get('entity_type.manager')
->getStorage('entity_test')
->resetCache([
$id,
]);
$entity = EntityTest::load($id);
$this
->assertEquals($value, $entity->{$field_name}->value, 'Field value was updated');
// Empty the field.
$value = '';
$edit = [
"{$field_name}[0][value]" => $value,
];
$this
->drupalGet('entity_test/manage/' . $id . '/edit');
$this
->submitForm($edit, 'Save');
$this
->assertSession()
->pageTextContains('entity_test ' . $id . ' has been updated.');
$this->container
->get('entity_type.manager')
->getStorage('entity_test')
->resetCache([
$id,
]);
$entity = EntityTest::load($id);
$this
->assertTrue($entity->{$field_name}
->isEmpty(), 'Field was emptied');
}
/**
* Tests field widget default values on entity forms.
*/
public function testFieldFormDefaultValue() {
$field_storage = $this->fieldStorageSingle;
$field_name = $field_storage['field_name'];
$this->field['field_name'] = $field_name;
$default = rand(1, 127);
$this->field['default_value'] = [
[
'value' => $default,
],
];
FieldStorageConfig::create($field_storage)
->save();
FieldConfig::create($this->field)
->save();
\Drupal::service('entity_display.repository')
->getFormDisplay($this->field['entity_type'], $this->field['bundle'])
->setComponent($field_name)
->save();
// Display creation form.
$this
->drupalGet('entity_test/add');
// Test that the default value is displayed correctly.
$this
->assertSession()
->fieldValueEquals("{$field_name}[0][value]", $default);
// Try to submit an empty value.
$edit = [
"{$field_name}[0][value]" => '',
];
$this
->submitForm($edit, 'Save');
preg_match('|entity_test/manage/(\\d+)|', $this
->getUrl(), $match);
$id = $match[1];
$this
->assertSession()
->pageTextContains('entity_test ' . $id . ' has been created.');
$entity = EntityTest::load($id);
$this
->assertTrue($entity->{$field_name}
->isEmpty(), 'Field is now empty.');
}
public function testFieldFormSingleRequired() {
$field_storage = $this->fieldStorageSingle;
$field_name = $field_storage['field_name'];
$this->field['field_name'] = $field_name;
$this->field['required'] = TRUE;
FieldStorageConfig::create($field_storage)
->save();
FieldConfig::create($this->field)
->save();
\Drupal::service('entity_display.repository')
->getFormDisplay($this->field['entity_type'], $this->field['bundle'])
->setComponent($field_name)
->save();
// Submit with missing required value.
$edit = [];
$this
->drupalGet('entity_test/add');
$this
->submitForm($edit, 'Save');
$this
->assertSession()
->pageTextContains("{$this->field['label']} field is required.");
// Create an entity
$value = mt_rand(1, 127);
$edit = [
"{$field_name}[0][value]" => $value,
];
$this
->submitForm($edit, 'Save');
preg_match('|entity_test/manage/(\\d+)|', $this
->getUrl(), $match);
$id = $match[1];
$this
->assertSession()
->pageTextContains('entity_test ' . $id . ' has been created.');
$entity = EntityTest::load($id);
$this
->assertEquals($value, $entity->{$field_name}->value, 'Field value was saved');
// Edit with missing required value.
$value = '';
$edit = [
"{$field_name}[0][value]" => $value,
];
$this
->drupalGet('entity_test/manage/' . $id . '/edit');
$this
->submitForm($edit, 'Save');
$this
->assertSession()
->pageTextContains("{$this->field['label']} field is required.");
}
public function testFieldFormUnlimited() {
$field_storage = $this->fieldStorageUnlimited;
$field_name = $field_storage['field_name'];
$this->field['field_name'] = $field_name;
FieldStorageConfig::create($field_storage)
->save();
FieldConfig::create($this->field)
->save();
\Drupal::service('entity_display.repository')
->getFormDisplay($this->field['entity_type'], $this->field['bundle'])
->setComponent($field_name)
->save();
// Display creation form -> 1 widget.
$this
->drupalGet('entity_test/add');
$this
->assertSession()
->fieldValueEquals("{$field_name}[0][value]", '');
// Verify that no extraneous widget is displayed.
$this
->assertSession()
->fieldNotExists("{$field_name}[1][value]");
// Check if aria-describedby attribute is placed on multiple value widgets.
$elements = $this
->xpath('//table[@id="field-unlimited-values" and @aria-describedby="edit-field-unlimited--description"]');
$this
->assertTrue(isset($elements[0]), 'aria-describedby attribute is properly placed on multiple value widgets.');
// Press 'add more' button -> 2 widgets.
$this
->submitForm([], 'Add another item');
$this
->assertSession()
->fieldValueEquals("{$field_name}[0][value]", '');
$this
->assertSession()
->fieldValueEquals("{$field_name}[1][value]", '');
// Verify that no extraneous widget is displayed.
$this
->assertSession()
->fieldNotExists("{$field_name}[2][value]");
// TODO : check that non-field inputs are preserved ('title'), etc.
// Yet another time so that we can play with more values -> 3 widgets.
$this
->submitForm([], 'Add another item');
// Prepare values and weights.
$count = 3;
$delta_range = $count - 1;
$values = $weights = $pattern = $expected_values = [];
$edit = [];
for ($delta = 0; $delta <= $delta_range; $delta++) {
// Assign unique random values and weights.
do {
$value = mt_rand(1, 127);
} while (in_array($value, $values));
do {
$weight = mt_rand(-$delta_range, $delta_range);
} while (in_array($weight, $weights));
$edit["{$field_name}[{$delta}][value]"] = $value;
$edit["{$field_name}[{$delta}][_weight]"] = $weight;
// We'll need three slightly different formats to check the values.
$values[$delta] = $value;
$weights[$delta] = $weight;
$field_values[$weight]['value'] = (string) $value;
$pattern[$weight] = "<input [^>]*value=\"{$value}\" [^>]*";
}
// Press 'add more' button -> 4 widgets
$this
->submitForm($edit, 'Add another item');
for ($delta = 0; $delta <= $delta_range; $delta++) {
$this
->assertSession()
->fieldValueEquals("{$field_name}[{$delta}][value]", $values[$delta]);
$this
->assertSession()
->fieldValueEquals("{$field_name}[{$delta}][_weight]", $weights[$delta]);
}
ksort($pattern);
$pattern = implode('.*', array_values($pattern));
// Verify that the widgets are displayed in the correct order.
$this
->assertSession()
->responseMatches("|{$pattern}|s");
$this
->assertSession()
->fieldValueEquals("{$field_name}[{$delta}][value]", '');
$this
->assertSession()
->fieldValueEquals("{$field_name}[{$delta}][_weight]", $delta);
// Verify that no extraneous widget is displayed.
$this
->assertSession()
->fieldNotExists("{$field_name}[" . ($delta + 1) . '][value]');
// Submit the form and create the entity.
$this
->submitForm($edit, 'Save');
preg_match('|entity_test/manage/(\\d+)|', $this
->getUrl(), $match);
$id = $match[1];
$this
->assertSession()
->pageTextContains('entity_test ' . $id . ' has been created.');
$entity = EntityTest::load($id);
ksort($field_values);
$field_values = array_values($field_values);
$this
->assertSame($field_values, $entity->{$field_name}
->getValue(), 'Field values were saved in the correct order');
// Display edit form: check that the expected number of widgets is
// displayed, with correct values change values, reorder, leave an empty
// value in the middle.
// Submit: check that the entity is updated with correct values
// Re-submit: check that the field can be emptied.
// Test with several multiple fields in a form
}
/**
* Tests the position of the required label.
*/
public function testFieldFormUnlimitedRequired() {
$field_name = $this->fieldStorageUnlimited['field_name'];
$this->field['field_name'] = $field_name;
$this->field['required'] = TRUE;
FieldStorageConfig::create($this->fieldStorageUnlimited)
->save();
FieldConfig::create($this->field)
->save();
\Drupal::service('entity_display.repository')
->getFormDisplay($this->field['entity_type'], $this->field['bundle'])
->setComponent($field_name)
->save();
// Display creation form -> 1 widget.
$this
->drupalGet('entity_test/add');
// Check that the Required symbol is present for the multifield label.
$element = $this
->xpath('//h4[contains(@class, "label") and contains(@class, "js-form-required") and contains(text(), :value)]', [
':value' => $this->field['label'],
]);
$this
->assertTrue(isset($element[0]), 'Required symbol added field label.');
// Check that the label of the field input is visually hidden and contains
// the field title and an indication of the delta for a11y.
$this
->assertSession()
->elementExists('xpath', "//label[@for='edit-field-unlimited-0-value' and contains(@class, 'visually-hidden') and contains(text(), '{$this->field['label']} (value 1)')]");
}
/**
* Tests widget handling of multiple required radios.
*/
public function testFieldFormMultivalueWithRequiredRadio() {
/** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */
$display_repository = \Drupal::service('entity_display.repository');
// Create a multivalue test field.
$field_storage = $this->fieldStorageUnlimited;
$field_name = $field_storage['field_name'];
$this->field['field_name'] = $field_name;
FieldStorageConfig::create($field_storage)
->save();
FieldConfig::create($this->field)
->save();
$display_repository
->getFormDisplay($this->field['entity_type'], $this->field['bundle'])
->setComponent($field_name)
->save();
// Add a required radio field.
FieldStorageConfig::create([
'field_name' => 'required_radio_test',
'entity_type' => 'entity_test',
'type' => 'list_string',
'settings' => [
'allowed_values' => [
'yes' => 'yes',
'no' => 'no',
],
],
])
->save();
$field = [
'field_name' => 'required_radio_test',
'entity_type' => 'entity_test',
'bundle' => 'entity_test',
'required' => TRUE,
];
FieldConfig::create($field)
->save();
$display_repository
->getFormDisplay($field['entity_type'], $field['bundle'])
->setComponent($field['field_name'], [
'type' => 'options_buttons',
])
->save();
// Display creation form.
$this
->drupalGet('entity_test/add');
// Press the 'Add more' button.
$this
->submitForm([], 'Add another item');
// Verify that no error is thrown by the radio element.
$this
->assertSession()
->elementNotExists('xpath', '//div[contains(@class, "error")]');
// Verify that the widget is added.
$this
->assertSession()
->fieldValueEquals("{$field_name}[0][value]", '');
$this
->assertSession()
->fieldValueEquals("{$field_name}[1][value]", '');
// Verify that no extraneous widget is displayed.
$this
->assertSession()
->fieldNotExists("{$field_name}[2][value]");
}
/**
* Tests widgets handling multiple values.
*/
public function testFieldFormMultipleWidget() {
// Create a field with fixed cardinality, configure the form to use a
// "multiple" widget.
$field_storage = $this->fieldStorageMultiple;
$field_name = $field_storage['field_name'];
$this->field['field_name'] = $field_name;
FieldStorageConfig::create($field_storage)
->save();
FieldConfig::create($this->field)
->save();
$form = \Drupal::service('entity_display.repository')
->getFormDisplay($this->field['entity_type'], $this->field['bundle'], 'default')
->setComponent($field_name, [
'type' => 'test_field_widget_multiple',
]);
$form
->save();
$session = $this
->assertSession();
// Display creation form.
$this
->drupalGet('entity_test/add');
$this
->assertSession()
->fieldValueEquals($field_name, '');
// Create entity with three values.
$edit = [
$field_name => '1, 2, 3',
];
$this
->submitForm($edit, 'Save');
preg_match('|entity_test/manage/(\\d+)|', $this
->getUrl(), $match);
$id = $match[1];
// Check that the values were saved.
$entity_init = EntityTest::load($id);
$this
->assertFieldValues($entity_init, $field_name, [
1,
2,
3,
]);
// Display the form, check that the values are correctly filled in.
$this
->drupalGet('entity_test/manage/' . $id . '/edit');
$this
->assertSession()
->fieldValueEquals($field_name, '1, 2, 3');
// Submit the form with more values than the field accepts.
$edit = [
$field_name => '1, 2, 3, 4, 5',
];
$this
->submitForm($edit, 'Save');
$this
->assertSession()
->pageTextContains('this field cannot hold more than 4 values');
// Check that the field values were not submitted.
$this
->assertFieldValues($entity_init, $field_name, [
1,
2,
3,
]);
// Check that Attributes are rendered on the multivalue container if it is
// a multiple widget form.
$form
->setComponent($field_name, [
'type' => 'entity_reference_autocomplete',
])
->save();
$this
->drupalGet('entity_test/manage/' . $id . '/edit');
$name = str_replace('_', '-', $field_name);
$session
->responseContains('data-drupal-selector="edit-' . $name . '"');
}
/**
* Tests fields with no 'edit' access.
*/
public function testFieldFormAccess() {
/** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */
$display_repository = \Drupal::service('entity_display.repository');
$entity_type = 'entity_test_rev';
// Create a "regular" field.
$field_storage = $this->fieldStorageSingle;
$field_storage['entity_type'] = $entity_type;
$field_name = $field_storage['field_name'];
$field = $this->field;
$field['field_name'] = $field_name;
$field['entity_type'] = $entity_type;
$field['bundle'] = $entity_type;
FieldStorageConfig::create($field_storage)
->save();
FieldConfig::create($field)
->save();
$display_repository
->getFormDisplay($entity_type, $entity_type)
->setComponent($field_name)
->save();
// Create a field with no edit access. See
// field_test_entity_field_access().
$field_storage_no_access = [
'field_name' => 'field_no_edit_access',
'entity_type' => $entity_type,
'type' => 'test_field',
];
$field_name_no_access = $field_storage_no_access['field_name'];
$field_no_access = [
'field_name' => $field_name_no_access,
'entity_type' => $entity_type,
'bundle' => $entity_type,
'default_value' => [
0 => [
'value' => 99,
],
],
];
FieldStorageConfig::create($field_storage_no_access)
->save();
FieldConfig::create($field_no_access)
->save();
$display_repository
->getFormDisplay($field_no_access['entity_type'], $field_no_access['bundle'])
->setComponent($field_name_no_access)
->save();
// Test that the form structure includes full information for each delta
// apart from #access.
$entity = $this->container
->get('entity_type.manager')
->getStorage($entity_type)
->create([
'id' => 0,
'revision_id' => 0,
]);
$display = $display_repository
->getFormDisplay($entity_type, $entity_type);
$form = [];
$form_state = new FormState();
$display
->buildForm($entity, $form, $form_state);
$this
->assertFalse($form[$field_name_no_access]['#access'], 'Field #access is FALSE for the field without edit access.');
// Display creation form.
$this
->drupalGet($entity_type . '/add');
// Check that the widget is not displayed if field access is denied.
$this
->assertSession()
->fieldNotExists("{$field_name_no_access}[0][value]");
// Create entity.
$edit = [
"{$field_name}[0][value]" => 1,
];
$this
->submitForm($edit, 'Save');
preg_match("|{$entity_type}/manage/(\\d+)|", $this
->getUrl(), $match);
$id = $match[1];
// Check that the default value was saved.
$storage = $this->container
->get('entity_type.manager')
->getStorage($entity_type);
$entity = $storage
->load($id);
$this
->assertEquals(99, $entity->{$field_name_no_access}->value, 'Default value was saved for the field with no edit access.');
$this
->assertEquals(1, $entity->{$field_name}->value, 'Entered value vas saved for the field with edit access.');
// Create a new revision.
$edit = [
"{$field_name}[0][value]" => 2,
'revision' => TRUE,
];
$this
->drupalGet($entity_type . '/manage/' . $id . '/edit');
$this
->submitForm($edit, 'Save');
// Check that the new revision has the expected values.
$storage
->resetCache([
$id,
]);
$entity = $storage
->load($id);
$this
->assertEquals(99, $entity->{$field_name_no_access}->value, 'New revision has the expected value for the field with no edit access.');
$this
->assertEquals(2, $entity->{$field_name}->value, 'New revision has the expected value for the field with edit access.');
// Check that the revision is also saved in the revisions table.
$entity = $this->container
->get('entity_type.manager')
->getStorage($entity_type)
->loadRevision($entity
->getRevisionId());
$this
->assertEquals(99, $entity->{$field_name_no_access}->value, 'New revision has the expected value for the field with no edit access.');
$this
->assertEquals(2, $entity->{$field_name}->value, 'New revision has the expected value for the field with edit access.');
}
/**
* Tests hiding a field in a form.
*/
public function testHiddenField() {
$entity_type = 'entity_test_rev';
$field_storage = $this->fieldStorageSingle;
$field_storage['entity_type'] = $entity_type;
$field_name = $field_storage['field_name'];
$this->field['field_name'] = $field_name;
$this->field['default_value'] = [
0 => [
'value' => 99,
],
];
$this->field['entity_type'] = $entity_type;
$this->field['bundle'] = $entity_type;
FieldStorageConfig::create($field_storage)
->save();
$this->field = FieldConfig::create($this->field);
$this->field
->save();
// We explicitly do not assign a widget in a form display, so the field
// stays hidden in forms.
// Display the entity creation form.
$this
->drupalGet($entity_type . '/add');
// Create an entity and test that the default value is assigned correctly to
// the field that uses the hidden widget.
$this
->assertSession()
->fieldNotExists("{$field_name}[0][value]");
$this
->submitForm([], 'Save');
preg_match('|' . $entity_type . '/manage/(\\d+)|', $this
->getUrl(), $match);
$id = $match[1];
$this
->assertSession()
->pageTextContains('entity_test_rev ' . $id . ' has been created.');
$storage = $this->container
->get('entity_type.manager')
->getStorage($entity_type);
$entity = $storage
->load($id);
$this
->assertEquals(99, $entity->{$field_name}->value, 'Default value was saved');
// Update the field to remove the default value, and switch to the default
// widget.
$this->field
->setDefaultValue([]);
$this->field
->save();
\Drupal::service('entity_display.repository')
->getFormDisplay($entity_type, $this->field
->getTargetBundle())
->setComponent($this->field
->getName(), [
'type' => 'test_field_widget',
])
->save();
// Display edit form.
$this
->drupalGet($entity_type . '/manage/' . $id . '/edit');
$this
->assertSession()
->fieldValueEquals("{$field_name}[0][value]", 99);
// Update the entity.
$value = mt_rand(1, 127);
$edit = [
"{$field_name}[0][value]" => $value,
];
$this
->submitForm($edit, 'Save');
$this
->assertSession()
->pageTextContains('entity_test_rev ' . $id . ' has been updated.');
$storage
->resetCache([
$id,
]);
$entity = $storage
->load($id);
$this
->assertEquals($value, $entity->{$field_name}->value, 'Field value was updated');
// Set the field back to hidden.
\Drupal::service('entity_display.repository')
->getFormDisplay($entity_type, $this->field
->getTargetBundle())
->removeComponent($this->field
->getName())
->save();
// Create a new revision.
$edit = [
'revision' => TRUE,
];
$this
->drupalGet($entity_type . '/manage/' . $id . '/edit');
$this
->submitForm($edit, 'Save');
// Check that the expected value has been carried over to the new revision.
$storage
->resetCache([
$id,
]);
$entity = $storage
->load($id);
$this
->assertEquals($value, $entity->{$field_name}->value, 'New revision has the expected value for the field with the Hidden widget');
}
/**
* Tests the form display of the label for multi-value fields.
*/
public function testLabelOnMultiValueFields() {
$user = $this
->drupalCreateUser([
'administer entity_test content',
]);
$this
->drupalLogin($user);
FieldStorageConfig::create([
'entity_type' => 'entity_test_base_field_display',
'field_name' => 'foo',
'type' => 'text',
'cardinality' => FieldStorageConfig::CARDINALITY_UNLIMITED,
])
->save();
FieldConfig::create([
'entity_type' => 'entity_test_base_field_display',
'bundle' => 'bar',
'field_name' => 'foo',
// Set a dangerous label to test XSS filtering.
'label' => "<script>alert('a configurable field');</script>",
])
->save();
EntityFormDisplay::create([
'targetEntityType' => 'entity_test_base_field_display',
'bundle' => 'bar',
'mode' => 'default',
])
->setComponent('foo', [
'type' => 'text_textfield',
])
->enable()
->save();
$entity = EntityTestBaseFieldDisplay::create([
'type' => 'bar',
]);
$entity
->save();
$this
->drupalGet('entity_test_base_field_display/manage/' . $entity
->id());
$this
->assertSession()
->statusCodeEquals(200);
$this
->assertSession()
->pageTextContains('A field with multiple values');
// Test if labels were XSS filtered.
$this
->assertSession()
->assertEscaped("<script>alert('a configurable field');</script>");
}
/**
* Tests hook_field_widget_complete_form_alter().
*/
public function testFieldFormMultipleWidgetAlter() {
$this
->widgetAlterTest('hook_field_widget_complete_form_alter', 'test_field_widget_multiple');
}
/**
* Tests hook_field_widget_complete_form_alter() with single value elements.
*/
public function testFieldFormMultipleWidgetAlterSingleValues() {
$this
->widgetAlterTest('hook_field_widget_complete_form_alter', 'test_field_widget_multiple_single_value');
}
/**
* Tests hook_field_widget_complete_WIDGET_TYPE_form_alter().
*/
public function testFieldFormMultipleWidgetTypeAlter() {
$this
->widgetAlterTest('hook_field_widget_complete_WIDGET_TYPE_form_alter', 'test_field_widget_multiple');
}
/**
* Tests hook_field_widget_complete_WIDGET_TYPE_form_alter() with single value elements.
*/
public function testFieldFormMultipleWidgetTypeAlterSingleValues() {
$this
->widgetAlterTest('hook_field_widget_complete_WIDGET_TYPE_form_alter', 'test_field_widget_multiple_single_value');
}
/**
* Tests widget alter hooks for a given hook name.
*/
protected function widgetAlterTest($hook, $widget) {
// Create a field with fixed cardinality, configure the form to use a
// "multiple" widget.
$field_storage = $this->fieldStorageMultiple;
$field_name = $field_storage['field_name'];
$this->field['field_name'] = $field_name;
FieldStorageConfig::create($field_storage)
->save();
FieldConfig::create($this->field)
->save();
// Set a flag in state so that the hook implementations will run.
\Drupal::state()
->set("field_test.widget_alter_test", [
'hook' => $hook,
'field_name' => $field_name,
'widget' => $widget,
]);
\Drupal::service('entity_display.repository')
->getFormDisplay($this->field['entity_type'], $this->field['bundle'], 'default')
->setComponent($field_name, [
'type' => $widget,
])
->save();
// We need to rebuild hook information after setting the component through
// the API.
$this
->rebuildAll();
$this
->drupalGet('entity_test/add');
$this
->assertSession()
->pageTextMatchesCount(1, '/From ' . $hook . '.* prefix on ' . $field_name . ' parent element\\./');
if ($widget === 'test_field_widget_multiple_single_value') {
$suffix_text = "From {$hook}(): suffix on {$field_name} child element.";
$this
->assertEquals($field_storage['cardinality'], substr_count($this
->getTextContent(), $suffix_text), "'{$suffix_text}' was found {$field_storage['cardinality']} times using widget {$widget}");
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | Asserts whether an expected cache tag was present in the last response. | |
AssertLegacyTrait:: |
protected | function | Asserts that the element with the given CSS selector is not present. | |
AssertLegacyTrait:: |
protected | function | Asserts that the element with the given CSS selector is present. | |
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | Passes if the raw text IS found escaped on the loaded page, fail otherwise. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists with the given name or ID. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists with the given ID and value. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists with the given name and value. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists in the current page by the given XPath. | |
AssertLegacyTrait:: |
protected | function | Asserts that a checkbox field in the current page is checked. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field exists in the current page with a given Xpath result. | |
AssertLegacyTrait:: |
protected | function | Checks that current response header equals value. | |
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | Passes if a link with the specified label is found. | |
AssertLegacyTrait:: |
protected | function | Passes if a link containing a given href (part) is found. | |
AssertLegacyTrait:: |
protected | function | Asserts whether an expected cache tag was absent in the last response. | |
AssertLegacyTrait:: |
protected | function | Passes if the raw text is not found escaped on the loaded page. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field does NOT exist with the given name or ID. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field does not exist with the given ID and value. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field does not exist with the given name and value. | |
AssertLegacyTrait:: |
protected | function | Asserts that a field does not exist or its value does not match, by XPath. | |
AssertLegacyTrait:: |
protected | function | Asserts that a checkbox field in the current page is not checked. | |
AssertLegacyTrait:: |
protected | function | Passes if a link with the specified label is not found. | |
AssertLegacyTrait:: |
protected | function | Passes if a link containing a given href (part) is not found. | |
AssertLegacyTrait:: |
protected | function | Asserts that a select option does NOT exist in the current page. | |
AssertLegacyTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is not found in the raw content. | |
AssertLegacyTrait:: |
protected | function | Passes if the raw text IS not found on the loaded page, fail otherwise. | |
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | Passes if the page (with HTML stripped) does not contains the text. | |
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | Passes if the text is found MORE THAN ONCE on the text version of the page. | |
AssertLegacyTrait:: |
protected | function | Asserts that a select option in the current page exists. | |
AssertLegacyTrait:: |
protected | function | Asserts that a select option with the visible text exists. | |
AssertLegacyTrait:: |
protected | function | Asserts that a select option in the current page is checked. | |
AssertLegacyTrait:: |
protected | function | Triggers a pass if the Perl regex pattern is found in the raw content. | |
AssertLegacyTrait:: |
protected | function | Passes if the raw text IS found on the loaded page, fail otherwise. | |
AssertLegacyTrait:: |
protected | function | Asserts the page responds with the specified response code. | |
AssertLegacyTrait:: |
protected | function | Passes if the page (with HTML stripped) contains the text. | |
AssertLegacyTrait:: |
protected | function | Helper for assertText and assertNoText. | |
AssertLegacyTrait:: |
protected | function | Pass if the page title is the given string. | |
AssertLegacyTrait:: |
protected | function | Passes if the text is found ONLY ONCE on the text version of the page. | |
AssertLegacyTrait:: |
protected | function | Passes if the internal browser's URL matches the given path. | |
AssertLegacyTrait:: |
protected | function | Builds an XPath query. | |
AssertLegacyTrait:: |
protected | function | Helper: Constructs an XPath for the given set of attributes and value. | |
AssertLegacyTrait:: |
protected | function | Get all option elements, including nested options, in a select. | |
AssertLegacyTrait:: |
protected | function | Gets the current raw content. | |
AssertLegacyTrait:: |
protected | function | ||
AssertLegacyTrait:: |
protected | function | ||
BlockCreationTrait:: |
protected | function | Creates a block instance based on default settings. Aliased as: drupalPlaceBlock | |
BrowserHtmlDebugTrait:: |
protected | property | The Base URI to use for links to the output files. | |
BrowserHtmlDebugTrait:: |
protected | property | Class name for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | Counter for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | Counter storage for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | Directory name for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | property | HTML output output enabled. | |
BrowserHtmlDebugTrait:: |
protected | property | The file name to write the list of URLs to. | |
BrowserHtmlDebugTrait:: |
protected | property | HTML output test ID. | |
BrowserHtmlDebugTrait:: |
protected | function | Formats HTTP headers as string for HTML output logging. | |
BrowserHtmlDebugTrait:: |
protected | function | Returns headers in HTML output format. | 1 |
BrowserHtmlDebugTrait:: |
protected | function | Provides a Guzzle middleware handler to log every response received. | |
BrowserHtmlDebugTrait:: |
protected | function | Logs a HTML output message in a text file. | |
BrowserHtmlDebugTrait:: |
protected | function | Creates the directory to store browser output. | |
BrowserTestBase:: |
protected | property | The base URL. | |
BrowserTestBase:: |
protected | property | The config importer that can be used in a test. | |
BrowserTestBase:: |
protected | property | An array of custom translations suitable for drupal_rewrite_settings(). | |
BrowserTestBase:: |
protected | property | The database prefix of this test run. | |
BrowserTestBase:: |
protected | property | Mink session manager. | |
BrowserTestBase:: |
protected | property | Mink default driver params. | |
BrowserTestBase:: |
protected | property | Mink class for the default driver to use. | 1 |
BrowserTestBase:: |
protected | property | The original container. | |
BrowserTestBase:: |
protected | property | The original array of shutdown function callbacks. | |
BrowserTestBase:: |
protected | property | ||
BrowserTestBase:: |
protected | property | The profile to install as a basis for testing. | 39 |
BrowserTestBase:: |
protected | property | The app root. | |
BrowserTestBase:: |
protected | property | Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests. | |
BrowserTestBase:: |
protected | property | Time limit in seconds for the test. | |
BrowserTestBase:: |
protected | property | The translation file directory for the test environment. | |
BrowserTestBase:: |
protected | function | Clean up the Simpletest environment. | |
BrowserTestBase:: |
protected | function | Configuration accessor for tests. Returns non-overridden configuration. | |
BrowserTestBase:: |
protected | function | Gets the value of an HTTP response header. | |
BrowserTestBase:: |
public static | function | Ensures test files are deletable. | |
BrowserTestBase:: |
protected | function | Gets an instance of the default Mink driver. | |
BrowserTestBase:: |
protected | function | Gets the JavaScript drupalSettings variable for the currently-loaded page. | 1 |
BrowserTestBase:: |
protected | function | Obtain the HTTP client for the system under test. | |
BrowserTestBase:: |
protected | function | Get the Mink driver args from an environment variable, if it is set. Can be overridden in a derived class so it is possible to use a different value for a subset of tests, e.g. the JavaScript tests. | 1 |
BrowserTestBase:: |
protected | function | Helper function to get the options of select field. | |
BrowserTestBase:: |
public | function | Returns Mink session. | |
BrowserTestBase:: |
protected | function | Get session cookies from current session. | |
BrowserTestBase:: |
protected | function |
Retrieves the current calling line in the class under test. Overrides BrowserHtmlDebugTrait:: |
|
BrowserTestBase:: |
protected | function | Visits the front page when initializing Mink. | 3 |
BrowserTestBase:: |
protected | function | Initializes Mink sessions. | 1 |
BrowserTestBase:: |
public | function | Installs Drupal into the Simpletest site. | 1 |
BrowserTestBase:: |
protected | function | Registers additional Mink sessions. | |
BrowserTestBase:: |
protected | function | Sets up the root application path. | |
BrowserTestBase:: |
public static | function | 1 | |
BrowserTestBase:: |
protected | function | 3 | |
BrowserTestBase:: |
protected | function | Transforms a nested array into a flat array suitable for submitForm(). | |
BrowserTestBase:: |
protected | function | Performs an xpath search on the contents of the internal browser. | |
BrowserTestBase:: |
public | function | Prevents serializing any properties. | |
ConfigTestTrait:: |
protected | function | Returns a ConfigImporter object to import test configuration. | |
ConfigTestTrait:: |
protected | function | Copies configuration objects from source storage to target storage. | |
ContentTypeCreationTrait:: |
protected | function | Creates a custom content type based on default settings. Aliased as: drupalCreateContentType | 1 |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified module. | |
ExtensionListTestTrait:: |
protected | function | Gets the path for the specified theme. | |
FieldTestBase:: |
public | function | Assert that a field has the expected values in an entity. | |
FieldTestBase:: |
public | function | Generate random values for a field_test field. | |
FormTest:: |
protected | property |
The theme to install as the default for testing. Overrides BrowserTestBase:: |
|
FormTest:: |
protected | property | An array of values defining a field. | |
FormTest:: |
protected | property | An array of values defining a field multiple. | |
FormTest:: |
protected | property | An array of values defining a field single. | |
FormTest:: |
protected | property | An array of values defining a field with unlimited cardinality. | |
FormTest:: |
protected static | property |
Modules to enable. Overrides BrowserTestBase:: |
|
FormTest:: |
protected | function |
Overrides BrowserTestBase:: |
|
FormTest:: |
public | function | Tests fields with no 'edit' access. | |
FormTest:: |
public | function | Tests field widget default values on entity forms. | |
FormTest:: |
public | function | Tests widgets handling multiple values. | |
FormTest:: |
public | function | Tests hook_field_widget_complete_form_alter(). | |
FormTest:: |
public | function | Tests hook_field_widget_complete_form_alter() with single value elements. | |
FormTest:: |
public | function | Tests hook_field_widget_complete_WIDGET_TYPE_form_alter(). | |
FormTest:: |
public | function | Tests hook_field_widget_complete_WIDGET_TYPE_form_alter() with single value elements. | |
FormTest:: |
public | function | Tests widget handling of multiple required radios. | |
FormTest:: |
public | function | ||
FormTest:: |
public | function | ||
FormTest:: |
public | function | ||
FormTest:: |
public | function | Tests the position of the required label. | |
FormTest:: |
public | function | Tests hiding a field in a form. | |
FormTest:: |
public | function | Tests the form display of the label for multi-value fields. | |
FormTest:: |
protected | function | Tests widget alter hooks for a given hook name. | |
FunctionalTestSetupTrait:: |
protected | property | The flag to set 'apcu_ensure_unique_prefix' setting. | 1 |
FunctionalTestSetupTrait:: |
protected | property | The class loader to use for installation and initialization of setup. | |
FunctionalTestSetupTrait:: |
protected | property | The "#1" admin user. | |
FunctionalTestSetupTrait:: |
protected | function | Execute the non-interactive installer. | 1 |
FunctionalTestSetupTrait:: |
protected | function | Returns all supported database driver installer objects. | |
FunctionalTestSetupTrait:: |
protected | function | Initialize various configurations post-installation. | 1 |
FunctionalTestSetupTrait:: |
protected | function | Initializes the kernel after installation. | |
FunctionalTestSetupTrait:: |
protected | function | Initialize settings created during install. | |
FunctionalTestSetupTrait:: |
protected | function | Initializes user 1 for the site to be installed. | |
FunctionalTestSetupTrait:: |
protected | function | Installs the default theme defined by `static::$defaultTheme` when needed. | |
FunctionalTestSetupTrait:: |
protected | function | Install modules defined by `static::$modules`. | 1 |
FunctionalTestSetupTrait:: |
protected | function | Returns the parameters that will be used when Simpletest installs Drupal. | 9 |
FunctionalTestSetupTrait:: |
protected | function | Prepares the current environment for running the test. | 20 |
FunctionalTestSetupTrait:: |
protected | function | Creates a mock request and sets it on the generator. | |
FunctionalTestSetupTrait:: |
protected | function | Prepares site settings and services before installation. | 2 |
FunctionalTestSetupTrait:: |
protected | function | Resets and rebuilds the environment after setup. | |
FunctionalTestSetupTrait:: |
protected | function | Rebuilds \Drupal::getContainer(). | |
FunctionalTestSetupTrait:: |
protected | function | Resets all data structures after having enabled new modules. | |
FunctionalTestSetupTrait:: |
protected | function | Changes parameters in the services.yml file. | |
FunctionalTestSetupTrait:: |
protected | function | Sets up the base URL based upon the environment variable. | |
FunctionalTestSetupTrait:: |
protected | function | Rewrites the settings.php file of the test site. | 1 |
NodeCreationTrait:: |
protected | function | Creates a node based on default settings. Aliased as: drupalCreateNode | |
NodeCreationTrait:: |
public | function | Get a node from the database based on its title. Aliased as: drupalGetNodeByTitle | |
PhpUnitWarnings:: |
private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | |
PhpUnitWarnings:: |
public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | |
RandomGeneratorTrait:: |
protected | property | The random generator. | |
RandomGeneratorTrait:: |
protected | function | Gets the random generator for the utility methods. | |
RandomGeneratorTrait:: |
protected | function | Generates a unique random string containing letters and numbers. | 1 |
RandomGeneratorTrait:: |
public | function | Generates a random PHP object. | |
RandomGeneratorTrait:: |
public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | |
RandomGeneratorTrait:: |
public | function | Callback for random string validation. | |
RefreshVariablesTrait:: |
protected | function | Refreshes in-memory configuration and state information. | 1 |
SessionTestTrait:: |
protected | property | The name of the session cookie. | |
SessionTestTrait:: |
protected | function | Generates a session cookie name. | |
SessionTestTrait:: |
protected | function | Returns the session name in use on the child site. | |
StorageCopyTrait:: |
protected static | function | Copy the configuration from one storage to another and remove stale items. | |
TestRequirementsTrait:: |
private | function | Checks missing module requirements. | |
TestRequirementsTrait:: |
protected | function | Check module requirements for the Drupal use case. | 1 |
TestRequirementsTrait:: |
protected static | function | Returns the Drupal root directory. | |
TestSetupTrait:: |
protected static | property | An array of config object names that are excluded from schema checking. | |
TestSetupTrait:: |
protected | property | The dependency injection container used in the test. | |
TestSetupTrait:: |
protected | property | The DrupalKernel instance used in the test. | |
TestSetupTrait:: |
protected | property | The site directory of the original parent site. | |
TestSetupTrait:: |
protected | property | The private file directory for the test environment. | |
TestSetupTrait:: |
protected | property | The public file directory for the test environment. | |
TestSetupTrait:: |
protected | property | The site directory of this test run. | |
TestSetupTrait:: |
protected | property | Set to TRUE to strict check all configuration saved. | 1 |
TestSetupTrait:: |
protected | property | The temporary file directory for the test environment. | |
TestSetupTrait:: |
protected | property | The test run ID. | |
TestSetupTrait:: |
protected | function | Changes the database connection to the prefixed one. | |
TestSetupTrait:: |
protected | function | Gets the config schema exclusions for this test. | |
TestSetupTrait:: |
public static | function | Returns the database connection to the site running Simpletest. | |
TestSetupTrait:: |
protected | function | Generates a database prefix for running tests. | 1 |
UiHelperTrait:: |
protected | property | The current user logged in using the Mink controlled browser. | |
UiHelperTrait:: |
protected | property | The number of meta refresh redirects to follow, or NULL if unlimited. | |
UiHelperTrait:: |
protected | property | The number of meta refresh redirects followed during ::drupalGet(). | |
UiHelperTrait:: |
public | function | Returns WebAssert object. | 1 |
UiHelperTrait:: |
protected | function | Builds an absolute URL from a system path or a URL object. | |
UiHelperTrait:: |
protected | function | Checks for meta refresh tag and if found call drupalGet() recursively. | |
UiHelperTrait:: |
protected | function | Clicks the element with the given CSS selector. | |
UiHelperTrait:: |
protected | function | Follows a link by complete name. | |
UiHelperTrait:: |
protected | function | Searches elements using a CSS selector in the raw content. | |
UiHelperTrait:: |
protected | function | Translates a CSS expression to its XPath equivalent. | |
UiHelperTrait:: |
protected | function | Retrieves a Drupal path or an absolute path. | 2 |
UiHelperTrait:: |
protected | function | Logs in a user using the Mink controlled browser. | |
UiHelperTrait:: |
protected | function | Logs a user out of the Mink controlled browser and confirms. | |
UiHelperTrait:: |
protected | function | Executes a form submission. | |
UiHelperTrait:: |
protected | function | Returns whether a given user account is logged in. | |
UiHelperTrait:: |
protected | function | Takes a path and returns an absolute path. | |
UiHelperTrait:: |
protected | function | Retrieves the plain-text content from the current page. | |
UiHelperTrait:: |
protected | function | Get the current URL from the browser. | |
UiHelperTrait:: |
protected | function | Determines if test is using DrupalTestBrowser. | |
UiHelperTrait:: |
protected | function | Prepare for a request to testing site. | 1 |
UiHelperTrait:: |
protected | function | Fills and submits a form. | |
UserCreationTrait:: |
protected | function | Checks whether a given list of permission names is valid. | |
UserCreationTrait:: |
protected | function | Creates an administrative role. | |
UserCreationTrait:: |
protected | function | Creates a role with specified permissions. Aliased as: drupalCreateRole | |
UserCreationTrait:: |
protected | function | Create a user with a given set of permissions. Aliased as: drupalCreateUser | |
UserCreationTrait:: |
protected | function | Grant permissions to a user role. | |
UserCreationTrait:: |
protected | function | Switch the current logged in user. | |
UserCreationTrait:: |
protected | function | Creates a random user account and sets it as current user. | |
XdebugRequestTrait:: |
protected | function | Adds xdebug cookies, from request setup. |