class OptionsWidgetsTest
Same name in other branches
- 9 core/modules/options/tests/src/Functional/OptionsWidgetsTest.php \Drupal\Tests\options\Functional\OptionsWidgetsTest
- 8.9.x core/modules/options/tests/src/Functional/OptionsWidgetsTest.php \Drupal\Tests\options\Functional\OptionsWidgetsTest
- 11.x core/modules/options/tests/src/Functional/OptionsWidgetsTest.php \Drupal\Tests\options\Functional\OptionsWidgetsTest
Tests the Options widgets.
@group options @group #slow
Hierarchy
- class \Drupal\Tests\BrowserTestBase extends \PHPUnit\Framework\TestCase uses \Drupal\Core\Test\FunctionalTestSetupTrait, \Drupal\Tests\UiHelperTrait, \Drupal\Core\Test\TestSetupTrait, \Drupal\Tests\block\Traits\BlockCreationTrait, \Drupal\Tests\RandomGeneratorTrait, \Drupal\Tests\node\Traits\NodeCreationTrait, \Drupal\Tests\node\Traits\ContentTypeCreationTrait, \Drupal\Tests\ConfigTestTrait, \Drupal\Tests\TestRequirementsTrait, \Drupal\Tests\user\Traits\UserCreationTrait, \Drupal\Tests\XdebugRequestTrait, \Drupal\Tests\Traits\PhpUnitWarnings, \Drupal\Tests\PhpUnitCompatibilityTrait, \Symfony\Bridge\PhpUnit\ExpectDeprecationTrait, \Drupal\Tests\ExtensionListTestTrait
- class \Drupal\Tests\field\Functional\FieldTestBase extends \Drupal\Tests\BrowserTestBase
- class \Drupal\Tests\options\Functional\OptionsWidgetsTest extends \Drupal\Tests\field\Functional\FieldTestBase
- class \Drupal\Tests\field\Functional\FieldTestBase extends \Drupal\Tests\BrowserTestBase
Expanded class hierarchy of OptionsWidgetsTest
File
-
core/
modules/ options/ tests/ src/ Functional/ OptionsWidgetsTest.php, line 18
Namespace
Drupal\Tests\options\FunctionalView source
class OptionsWidgetsTest extends FieldTestBase {
/**
* {@inheritdoc}
*/
protected static $modules = [
'node',
'options',
'entity_test',
'options_test',
'taxonomy',
'field_ui',
];
/**
* {@inheritdoc}
*/
protected $defaultTheme = 'stark';
/**
* A field storage with cardinality 1 to use in this test class.
*
* @var \Drupal\field\Entity\FieldStorageConfig
*/
protected $card1;
/**
* A field storage with cardinality 2 to use in this test class.
*
* @var \Drupal\field\Entity\FieldStorageConfig
*/
protected $card2;
/**
* A field storage with float values to use in this test class.
*
* @var \Drupal\field\Entity\FieldStorageConfig
*/
protected $float;
/**
* {@inheritdoc}
*/
protected function setUp() : void {
parent::setUp();
// Field storage with cardinality 1.
$this->card1 = FieldStorageConfig::create([
'field_name' => 'card_1',
'entity_type' => 'entity_test',
'type' => 'list_integer',
'cardinality' => 1,
'settings' => [
'allowed_values' => [
// Make sure that 0 works as an option.
0 => 'Zero',
1 => 'One',
// Make sure that option text is properly sanitized.
2 => 'Some <script>dangerous</script> & unescaped <strong>markup</strong>',
// Make sure that HTML entities in option text are not double-encoded.
3 => 'Some HTML encoded markup with < & >',
],
],
]);
$this->card1
->save();
// Field storage with cardinality 2.
$this->card2 = FieldStorageConfig::create([
'field_name' => 'card_2',
'entity_type' => 'entity_test',
'type' => 'list_integer',
'cardinality' => 2,
'settings' => [
'allowed_values' => [
// Make sure that 0 works as an option.
0 => 'Zero',
1 => 'One',
// Make sure that option text is properly sanitized.
2 => 'Some <script>dangerous</script> & unescaped <strong>markup</strong>',
],
],
]);
$this->card2
->save();
// Field storage with list of float values.
$this->float = FieldStorageConfig::create([
'field_name' => 'float',
'entity_type' => 'entity_test',
'type' => 'list_float',
'cardinality' => 1,
'settings' => [
'allowed_values' => [
'0.0' => '0.0',
'1.5' => '1.5',
'2.0' => '2.0',
],
],
]);
$this->float
->save();
// Create a web user.
$this->drupalLogin($this->drupalCreateUser([
'view test entity',
'administer entity_test content',
]));
}
/**
* Tests the 'options_buttons' widget (single select).
*/
public function testRadioButtons() : void {
// Create an instance of the 'single value' field.
$field = FieldConfig::create([
'field_storage' => $this->card1,
'bundle' => 'entity_test',
]);
$field->save();
\Drupal::service('entity_display.repository')->getFormDisplay('entity_test', 'entity_test')
->setComponent($this->card1
->getName(), [
'type' => 'options_buttons',
])
->save();
// Create an entity.
$entity = EntityTest::create([
'user_id' => 1,
'name' => $this->randomMachineName(),
]);
$entity->save();
$entity_init = clone $entity;
// With no field data, no buttons are checked.
$this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');
$this->assertSession()
->checkboxNotChecked('edit-card-1-0');
$this->assertSession()
->checkboxNotChecked('edit-card-1-1');
$this->assertSession()
->checkboxNotChecked('edit-card-1-2');
$this->assertSession()
->responseContains('Some dangerous & unescaped <strong>markup</strong>');
$this->assertSession()
->responseContains('Some HTML encoded markup with < & >');
// Select first option.
$edit = [
'card_1' => 0,
];
$this->submitForm($edit, 'Save');
$this->assertFieldValues($entity_init, 'card_1', [
0,
]);
// Check that the selected button is checked.
$this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');
$this->assertSession()
->checkboxChecked('edit-card-1-0');
$this->assertSession()
->checkboxNotChecked('edit-card-1-1');
$this->assertSession()
->checkboxNotChecked('edit-card-1-2');
// Unselect option.
$edit = [
'card_1' => '_none',
];
$this->submitForm($edit, 'Save');
$this->assertFieldValues($entity_init, 'card_1', []);
// Check that required radios with one option is auto-selected.
$this->card1
->setSetting('allowed_values', [
99 => 'Only allowed value',
]);
$this->card1
->save();
$field->setRequired(TRUE);
$field->save();
$this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');
$this->assertSession()
->checkboxChecked('edit-card-1-99');
}
/**
* Tests the 'options_buttons' widget (multiple select).
*/
public function testCheckBoxes() : void {
// Create an instance of the 'multiple values' field.
$field = FieldConfig::create([
'field_storage' => $this->card2,
'bundle' => 'entity_test',
]);
$field->save();
\Drupal::service('entity_display.repository')->getFormDisplay('entity_test', 'entity_test')
->setComponent($this->card2
->getName(), [
'type' => 'options_buttons',
])
->save();
// Create an entity.
$entity = EntityTest::create([
'user_id' => 1,
'name' => $this->randomMachineName(),
]);
$entity->save();
$entity_init = clone $entity;
// Display form: with no field data, nothing is checked.
$this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');
$this->assertSession()
->checkboxNotChecked('edit-card-2-0');
$this->assertSession()
->checkboxNotChecked('edit-card-2-1');
$this->assertSession()
->checkboxNotChecked('edit-card-2-2');
$this->assertSession()
->responseContains('Some dangerous & unescaped <strong>markup</strong>');
// Submit form: select first and third options.
$edit = [
'card_2[0]' => TRUE,
'card_2[1]' => FALSE,
'card_2[2]' => TRUE,
];
$this->submitForm($edit, 'Save');
$this->assertFieldValues($entity_init, 'card_2', [
0,
2,
]);
// Display form: check that the right options are selected.
$this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');
$this->assertSession()
->checkboxChecked('edit-card-2-0');
$this->assertSession()
->checkboxNotChecked('edit-card-2-1');
$this->assertSession()
->checkboxChecked('edit-card-2-2');
// Submit form: select only first option.
$edit = [
'card_2[0]' => TRUE,
'card_2[1]' => FALSE,
'card_2[2]' => FALSE,
];
$this->submitForm($edit, 'Save');
$this->assertFieldValues($entity_init, 'card_2', [
0,
]);
// Display form: check that the right options are selected.
$this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');
$this->assertSession()
->checkboxChecked('edit-card-2-0');
$this->assertSession()
->checkboxNotChecked('edit-card-2-1');
$this->assertSession()
->checkboxNotChecked('edit-card-2-2');
// Submit form: select the three options while the field accepts only 2.
$edit = [
'card_2[0]' => TRUE,
'card_2[1]' => TRUE,
'card_2[2]' => TRUE,
];
$this->submitForm($edit, 'Save');
$this->assertSession()
->pageTextContains('this field cannot hold more than 2 values');
// Submit form: uncheck all options.
$edit = [
'card_2[0]' => FALSE,
'card_2[1]' => FALSE,
'card_2[2]' => FALSE,
];
$this->submitForm($edit, 'Save');
// Check that the value was saved.
$this->assertFieldValues($entity_init, 'card_2', []);
// Required checkbox with one option is auto-selected.
$this->card2
->setSetting('allowed_values', [
99 => 'Only allowed value',
]);
$this->card2
->save();
$field->setRequired(TRUE);
$field->save();
$this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');
$this->assertSession()
->checkboxChecked('edit-card-2-99');
}
/**
* Tests the 'options_select' widget (single select).
*/
public function testSelectListSingle() : void {
// Create an instance of the 'single value' field.
$field = FieldConfig::create([
'field_storage' => $this->card1,
'bundle' => 'entity_test',
'required' => TRUE,
]);
$field->save();
\Drupal::service('entity_display.repository')->getFormDisplay('entity_test', 'entity_test')
->setComponent($this->card1
->getName(), [
'type' => 'options_select',
])
->save();
// Create an entity.
$entity = EntityTest::create([
'user_id' => 1,
'name' => $this->randomMachineName(),
]);
$entity->save();
$entity_init = clone $entity;
// Display form.
$this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');
// A required field without any value has a "none" option.
$option = $this->assertSession()
->optionExists('edit-card-1', '_none');
$this->assertSame('- Select a value -', $option->getText());
// With no field data, nothing is selected.
$this->assertTrue($this->assertSession()
->optionExists('card_1', '_none')
->isSelected());
$this->assertFalse($this->assertSession()
->optionExists('card_1', 0)
->isSelected());
$this->assertFalse($this->assertSession()
->optionExists('card_1', 1)
->isSelected());
$this->assertFalse($this->assertSession()
->optionExists('card_1', 2)
->isSelected());
$this->assertSession()
->responseContains('Some dangerous & unescaped markup');
// Submit form: select invalid 'none' option.
$edit = [
'card_1' => '_none',
];
$this->submitForm($edit, 'Save');
$this->assertSession()
->pageTextContains("{$field->getName()} field is required.");
// Submit form: select first option.
$edit = [
'card_1' => 0,
];
$this->submitForm($edit, 'Save');
$this->assertFieldValues($entity_init, 'card_1', [
0,
]);
// Display form: check that the right options are selected.
$this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');
// A required field with a value has no 'none' option.
$this->assertSession()
->optionNotExists('edit-card-1', '_none');
$this->assertTrue($this->assertSession()
->optionExists('card_1', 0)
->isSelected());
$this->assertFalse($this->assertSession()
->optionExists('card_1', 1)
->isSelected());
$this->assertFalse($this->assertSession()
->optionExists('card_1', 2)
->isSelected());
// Make the field non required.
$field->setRequired(FALSE);
$field->save();
// Display form.
$this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');
// A non-required field has a 'none' option.
$option = $this->assertSession()
->optionExists('edit-card-1', '_none');
$this->assertSame('- None -', $option->getText());
// Submit form: Unselect the option.
$edit = [
'card_1' => '_none',
];
$this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');
$this->submitForm($edit, 'Save');
$this->assertFieldValues($entity_init, 'card_1', []);
// Test optgroups.
$this->card1
->setSetting('allowed_values', []);
$this->card1
->setSetting('allowed_values_function', 'options_test_allowed_values_callback');
$this->card1
->save();
// Display form: with no field data, nothing is selected
$this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');
$this->assertFalse($this->assertSession()
->optionExists('card_1', 0)
->isSelected());
$this->assertFalse($this->assertSession()
->optionExists('card_1', 1)
->isSelected());
$this->assertFalse($this->assertSession()
->optionExists('card_1', 2)
->isSelected());
$this->assertSession()
->responseContains('Some dangerous & unescaped markup');
$this->assertSession()
->responseContains('More <script>dangerous</script> markup');
$this->assertSession()
->responseContains('Group 1');
// Submit form: select first option.
$edit = [
'card_1' => 0,
];
$this->submitForm($edit, 'Save');
$this->assertFieldValues($entity_init, 'card_1', [
0,
]);
// Display form: check that the right options are selected.
$this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');
$this->assertTrue($this->assertSession()
->optionExists('card_1', 0)
->isSelected());
$this->assertFalse($this->assertSession()
->optionExists('card_1', 1)
->isSelected());
$this->assertFalse($this->assertSession()
->optionExists('card_1', 2)
->isSelected());
// Submit form: Unselect the option.
$edit = [
'card_1' => '_none',
];
$this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');
$this->submitForm($edit, 'Save');
$this->assertFieldValues($entity_init, 'card_1', []);
}
/**
* Tests the '#required_error' attribute for the select list.
*/
public function testSelectListRequiredErrorAttribute() : void {
// Enable form alter hook.
\Drupal::state()->set('options_test.form_alter_enable', TRUE);
// Create an instance of the 'single value' field.
$field = FieldConfig::create([
'field_storage' => $this->card1,
'bundle' => 'entity_test',
'required' => TRUE,
]);
$field->save();
\Drupal::service('entity_display.repository')->getFormDisplay('entity_test', 'entity_test')
->setComponent($this->card1
->getName(), [
'type' => 'options_select',
])
->save();
// Create an entity.
$entity = EntityTest::create([
'user_id' => 1,
'name' => $this->randomMachineName(),
]);
$entity->save();
$this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');
// A required field without any value has a "none" option.
$option = $this->assertSession()
->optionExists('edit-card-1', '_none');
$this->assertSame('- Select a value -', $option->getText());
// Submit form: select invalid 'none' option.
$edit = [
'card_1' => '_none',
];
$this->submitForm($edit, 'Save');
$this->assertSession()
->responseContains(t('This is custom message for required field.'));
}
/**
* Tests the 'options_select' widget (multiple select).
*/
public function testSelectListMultiple() : void {
// Create an instance of the 'multiple values' field.
$field = FieldConfig::create([
'field_storage' => $this->card2,
'bundle' => 'entity_test',
]);
$field->save();
\Drupal::service('entity_display.repository')->getFormDisplay('entity_test', 'entity_test')
->setComponent($this->card2
->getName(), [
'type' => 'options_select',
])
->save();
// Create an entity.
$entity = EntityTest::create([
'user_id' => 1,
'name' => $this->randomMachineName(),
]);
$entity->save();
$entity_init = clone $entity;
// Display form: with no field data, nothing is selected.
$this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');
$this->assertTrue($this->assertSession()
->optionExists('card_2', '_none')
->isSelected());
$this->assertFalse($this->assertSession()
->optionExists('card_2', 0)
->isSelected());
$this->assertFalse($this->assertSession()
->optionExists('card_2', 1)
->isSelected());
$this->assertFalse($this->assertSession()
->optionExists('card_2', 2)
->isSelected());
$this->assertSession()
->responseContains('Some dangerous & unescaped markup');
// Submit form: select first and third options.
$edit = [
'card_2[]' => [
0 => 0,
2 => 2,
],
];
$this->submitForm($edit, 'Save');
$this->assertFieldValues($entity_init, 'card_2', [
0,
2,
]);
// Display form: check that the right options are selected.
$this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');
$this->assertTrue($this->assertSession()
->optionExists('card_2', 0)
->isSelected());
$this->assertFalse($this->assertSession()
->optionExists('card_2', 1)
->isSelected());
$this->assertTrue($this->assertSession()
->optionExists('card_2', 2)
->isSelected());
// Submit form: select only first option.
$edit = [
'card_2[]' => [
0 => 0,
],
];
$this->submitForm($edit, 'Save');
$this->assertFieldValues($entity_init, 'card_2', [
0,
]);
// Display form: check that the right options are selected.
$this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');
$this->assertTrue($this->assertSession()
->optionExists('card_2', 0)
->isSelected());
$this->assertFalse($this->assertSession()
->optionExists('card_2', 1)
->isSelected());
$this->assertFalse($this->assertSession()
->optionExists('card_2', 2)
->isSelected());
// Submit form: select the three options while the field accepts only 2.
$edit = [
'card_2[]' => [
0 => 0,
1 => 1,
2 => 2,
],
];
$this->submitForm($edit, 'Save');
$this->assertSession()
->pageTextContains('this field cannot hold more than 2 values');
// Submit form: uncheck all options.
$edit = [
'card_2[]' => [],
];
$this->submitForm($edit, 'Save');
$this->assertFieldValues($entity_init, 'card_2', []);
// Test the 'None' option.
// Check that the 'none' option has no effect if actual options are selected
// as well.
$edit = [
'card_2[]' => [
'_none' => '_none',
0 => 0,
],
];
$this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');
$this->submitForm($edit, 'Save');
$this->assertFieldValues($entity_init, 'card_2', [
0,
]);
// Check that selecting the 'none' option empties the field.
$edit = [
'card_2[]' => [
'_none' => '_none',
],
];
$this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');
$this->submitForm($edit, 'Save');
$this->assertFieldValues($entity_init, 'card_2', []);
// A required select list does not have an empty key.
$field->setRequired(TRUE);
$field->save();
$this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');
$this->assertEmpty($this->assertSession()
->selectExists('edit-card-2')
->find('xpath', 'option[@value=""]'));
// We do not have to test that a required select list with one option is
// auto-selected because the browser does it for us.
// Test optgroups.
// Use a callback function defining optgroups.
$this->card2
->setSetting('allowed_values', []);
$this->card2
->setSetting('allowed_values_function', 'options_test_allowed_values_callback');
$this->card2
->save();
$field->setRequired(FALSE);
$field->save();
// Display form: with no field data, nothing is selected.
$this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');
$this->assertFalse($this->assertSession()
->optionExists('card_2', 0)
->isSelected());
$this->assertFalse($this->assertSession()
->optionExists('card_2', 1)
->isSelected());
$this->assertFalse($this->assertSession()
->optionExists('card_2', 2)
->isSelected());
$this->assertSession()
->responseContains('Some dangerous & unescaped markup');
$this->assertSession()
->responseContains('More <script>dangerous</script> markup');
$this->assertSession()
->responseContains('Group 1');
// Submit form: select first option.
$edit = [
'card_2[]' => [
0 => 0,
],
];
$this->submitForm($edit, 'Save');
$this->assertFieldValues($entity_init, 'card_2', [
0,
]);
// Display form: check that the right options are selected.
$this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');
$this->assertTrue($this->assertSession()
->optionExists('card_2', 0)
->isSelected());
$this->assertFalse($this->assertSession()
->optionExists('card_2', 1)
->isSelected());
$this->assertFalse($this->assertSession()
->optionExists('card_2', 2)
->isSelected());
// Submit form: Unselect the option.
$edit = [
'card_2[]' => [
'_none' => '_none',
],
];
$this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');
$this->submitForm($edit, 'Save');
$this->assertFieldValues($entity_init, 'card_2', []);
}
/**
* Tests the 'options_select' widget (float values).
*/
public function testSelectListFloat() : void {
// Create an instance of the 'float value' field.
$field = FieldConfig::create([
'field_storage' => $this->float,
'bundle' => 'entity_test',
'required' => TRUE,
]);
$field->save();
$this->container
->get('entity_type.manager')
->getStorage('entity_form_display')
->load('entity_test.entity_test.default')
->setComponent($this->float
->getName(), [
'type' => 'options_select',
])
->save();
// Create an entity.
$entity = EntityTest::create([
'user_id' => 1,
'name' => $this->randomMachineName(),
]);
$entity->save();
// Display form.
$this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');
// With no field data, nothing is selected.
$this->assertFalse($this->assertSession()
->optionExists('float', 0)
->isSelected());
$this->assertFalse($this->assertSession()
->optionExists('float', 1.5)
->isSelected());
$this->assertFalse($this->assertSession()
->optionExists('float', 2)
->isSelected());
// Submit form.
$edit = [
'float' => 1.5,
];
$this->submitForm($edit, 'Save');
$this->assertFieldValues($entity, 'float', [
1.5,
]);
// Display form: check that the right options are selected.
$this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');
$this->assertFalse($this->assertSession()
->optionExists('float', 0)
->isSelected());
$this->assertTrue($this->assertSession()
->optionExists('float', 1.5)
->isSelected());
$this->assertFalse($this->assertSession()
->optionExists('float', 2)
->isSelected());
}
/**
* Tests the 'options_select' and 'options_button' widget for empty value.
*/
public function testEmptyValue() : void {
// Create an instance of the 'single value' field.
$field = FieldConfig::create([
'field_storage' => $this->card1,
'bundle' => 'entity_test',
]);
$field->save();
/** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */
$display_repository = \Drupal::service('entity_display.repository');
// Change it to the check boxes/radio buttons widget.
$display_repository->getFormDisplay('entity_test', 'entity_test')
->setComponent($this->card1
->getName(), [
'type' => 'options_buttons',
])
->save();
// Create an entity.
$entity = EntityTest::create([
'user_id' => 1,
'name' => $this->randomMachineName(),
]);
$entity->save();
// Display form: check that _none options are present and has label.
$this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');
// Verify that a test radio button has a "None" choice.
$this->assertSession()
->elementExists('xpath', '//div[@id="edit-card-1"]//input[@value="_none"]');
// Verify that a test radio button has a "N/A" choice..
$this->assertSession()
->elementExists('xpath', '//div[@id="edit-card-1"]//label[@for="edit-card-1-none"]');
$this->assertSession()
->elementTextEquals('xpath', '//div[@id="edit-card-1"]//label[@for="edit-card-1-none"]', "N/A");
// Change it to the select widget.
$display_repository->getFormDisplay('entity_test', 'entity_test')
->setComponent($this->card1
->getName(), [
'type' => 'options_select',
])
->save();
// Display form: check that _none options are present and has label.
$this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');
// A required field without any value has a "none" option.
$option = $this->assertSession()
->optionExists('edit-card-1', '_none');
$this->assertSame('- None -', $option->getText());
}
/**
* Tests hook_options_list_alter().
*
* @see options_test_options_list_alter()
*/
public function testOptionsListAlter() : void {
$field1 = FieldConfig::create([
'field_storage' => $this->card1,
'bundle' => 'entity_test',
]);
$field1->save();
// Create a new field that will be altered.
$card4 = FieldStorageConfig::create([
'field_name' => 'card_4',
'entity_type' => 'entity_test',
'type' => 'list_integer',
'cardinality' => 1,
'settings' => [
'allowed_values' => [
0 => 'Zero',
1 => 'One',
],
],
]);
$card4->save();
$field2 = FieldConfig::create([
'field_storage' => $card4,
'bundle' => 'entity_test',
]);
$field2->save();
/** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */
$display_repository = \Drupal::service('entity_display.repository');
// Change it to the check boxes/radio buttons widget.
$display_repository->getFormDisplay('entity_test', 'entity_test')
->setComponent($this->card1
->getName(), [
'type' => 'options_select',
])
->setComponent($card4->getName(), [
'type' => 'options_select',
])
->save();
// Create an entity.
$entity = EntityTest::create([
'user_id' => 1,
'name' => $this->randomMachineName(),
]);
$entity->save();
// Display form: check that _none options are present.
$this->drupalGet('entity_test/manage/' . $entity->id() . '/edit');
$xpath = '//select[@id=:id]//option[@value="_none" and text()=:label]';
$xpath_args = [
':id' => 'edit-card-1',
':label' => '- None -',
];
$this->assertSession()
->elementExists('xpath', $this->assertSession()
->buildXPathQuery($xpath, $xpath_args));
$xpath_args = [
':id' => 'edit-card-4',
':label' => '- Select something -',
];
$this->assertSession()
->elementExists('xpath', $this->assertSession()
->buildXPathQuery($xpath, $xpath_args));
// Display form: check that options are displayed correctly.
$this->assertSession()
->optionExists('card_1', 0);
$this->assertSession()
->optionExists('card_1', 1);
$this->assertSession()
->optionNotExists('card_4', 0);
$this->assertSession()
->optionExists('card_4', 1);
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Member alias | Overriden Title | Overrides |
---|---|---|---|---|---|---|---|
BlockCreationTrait::placeBlock | protected | function | Creates a block instance based on default settings. | Aliased as: drupalPlaceBlock | |||
BrowserHtmlDebugTrait::$htmlOutputBaseUrl | protected | property | The Base URI to use for links to the output files. | ||||
BrowserHtmlDebugTrait::$htmlOutputClassName | protected | property | Class name for HTML output logging. | ||||
BrowserHtmlDebugTrait::$htmlOutputCounter | protected | property | Counter for HTML output logging. | ||||
BrowserHtmlDebugTrait::$htmlOutputCounterStorage | protected | property | Counter storage for HTML output logging. | ||||
BrowserHtmlDebugTrait::$htmlOutputDirectory | protected | property | Directory name for HTML output logging. | ||||
BrowserHtmlDebugTrait::$htmlOutputEnabled | protected | property | HTML output enabled. | ||||
BrowserHtmlDebugTrait::$htmlOutputFile | protected | property | The file name to write the list of URLs to. | ||||
BrowserHtmlDebugTrait::$htmlOutputTestId | protected | property | HTML output test ID. | ||||
BrowserHtmlDebugTrait::formatHtmlOutputHeaders | protected | function | Formats HTTP headers as string for HTML output logging. | ||||
BrowserHtmlDebugTrait::getHtmlOutputHeaders | protected | function | Returns headers in HTML output format. | 1 | |||
BrowserHtmlDebugTrait::getResponseLogHandler | protected | function | Provides a Guzzle middleware handler to log every response received. | ||||
BrowserHtmlDebugTrait::htmlOutput | protected | function | Logs a HTML output message in a text file. | ||||
BrowserHtmlDebugTrait::initBrowserOutputFile | protected | function | Creates the directory to store browser output. | ||||
BrowserTestBase::$baseUrl | protected | property | The base URL. | ||||
BrowserTestBase::$configImporter | protected | property | The config importer that can be used in a test. | ||||
BrowserTestBase::$customTranslations | protected | property | An array of custom translations suitable for SettingsEditor::rewrite(). | ||||
BrowserTestBase::$mink | protected | property | Mink session manager. | ||||
BrowserTestBase::$minkDefaultDriverArgs | protected | property | Mink default driver params. | ||||
BrowserTestBase::$minkDefaultDriverClass | protected | property | Mink class for the default driver to use. | 1 | |||
BrowserTestBase::$originalContainer | protected | property | The original container. | ||||
BrowserTestBase::$originalShutdownCallbacks | protected | property | The original array of shutdown function callbacks. | ||||
BrowserTestBase::$preserveGlobalState | protected | property | |||||
BrowserTestBase::$profile | protected | property | The profile to install as a basis for testing. | 40 | |||
BrowserTestBase::$runTestInSeparateProcess | protected | property | Browser tests are run in separate processes to prevent collisions between code that may be loaded by tests. |
||||
BrowserTestBase::$timeLimit | protected | property | Time limit in seconds for the test. | ||||
BrowserTestBase::$translationFilesDirectory | protected | property | The translation file directory for the test environment. | ||||
BrowserTestBase::cleanupEnvironment | protected | function | Clean up the test environment. | ||||
BrowserTestBase::config | protected | function | Configuration accessor for tests. Returns non-overridden configuration. | ||||
BrowserTestBase::filePreDeleteCallback | public static | function | Ensures test files are deletable. | ||||
BrowserTestBase::getDefaultDriverInstance | protected | function | Gets an instance of the default Mink driver. | ||||
BrowserTestBase::getDrupalSettings | protected | function | Gets the JavaScript drupalSettings variable for the currently-loaded page. | 1 | |||
BrowserTestBase::getHttpClient | protected | function | Obtain the HTTP client for the system under test. | ||||
BrowserTestBase::getMinkDriverArgs | protected | function | Gets the Mink driver args from an environment variable. | 1 | |||
BrowserTestBase::getOptions | protected | function | Helper function to get the options of select field. | ||||
BrowserTestBase::getSession | public | function | Returns Mink session. | ||||
BrowserTestBase::getSessionCookies | protected | function | Get session cookies from current session. | ||||
BrowserTestBase::getTestMethodCaller | protected | function | Retrieves the current calling line in the class under test. | Overrides BrowserHtmlDebugTrait::getTestMethodCaller | |||
BrowserTestBase::initFrontPage | protected | function | Visits the front page when initializing Mink. | 3 | |||
BrowserTestBase::initMink | protected | function | Initializes Mink sessions. | 1 | |||
BrowserTestBase::installDrupal | public | function | Installs Drupal into the test site. | 2 | |||
BrowserTestBase::registerSessions | protected | function | Registers additional Mink sessions. | ||||
BrowserTestBase::setUpAppRoot | protected | function | Sets up the root application path. | ||||
BrowserTestBase::setUpBeforeClass | public static | function | 1 | ||||
BrowserTestBase::tearDown | protected | function | 3 | ||||
BrowserTestBase::translatePostValues | protected | function | Transforms a nested array into a flat array suitable for submitForm(). | ||||
BrowserTestBase::xpath | protected | function | Performs an xpath search on the contents of the internal browser. | ||||
BrowserTestBase::__get | public | function | |||||
BrowserTestBase::__sleep | public | function | Prevents serializing any properties. | ||||
ConfigTestTrait::configImporter | protected | function | Returns a ConfigImporter object to import test configuration. | ||||
ConfigTestTrait::copyConfig | protected | function | Copies configuration objects from source storage to target storage. | ||||
ContentTypeCreationTrait::createContentType | protected | function | Creates a custom content type based on default settings. | Aliased as: drupalCreateContentType | 1 | ||
ExtensionListTestTrait::getModulePath | protected | function | Gets the path for the specified module. | ||||
ExtensionListTestTrait::getThemePath | protected | function | Gets the path for the specified theme. | ||||
FieldTestBase::assertFieldValues | public | function | Assert that a field has the expected values in an entity. | ||||
FieldTestBase::_generateTestFieldValues | public | function | Generate random values for a field_test field. | ||||
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix | protected | property | The flag to set 'apcu_ensure_unique_prefix' setting. | 1 | |||
FunctionalTestSetupTrait::$classLoader | protected | property | The class loader to use for installation and initialization of setup. | ||||
FunctionalTestSetupTrait::$rootUser | protected | property | The "#1" admin user. | ||||
FunctionalTestSetupTrait::$usesSuperUserAccessPolicy | protected | property | Set to TRUE to make user 1 a super user. | 10 | |||
FunctionalTestSetupTrait::doInstall | protected | function | Execute the non-interactive installer. | 2 | |||
FunctionalTestSetupTrait::getDatabaseTypes | protected | function | Returns all supported database driver installer objects. | ||||
FunctionalTestSetupTrait::initConfig | protected | function | Initialize various configurations post-installation. | 1 | |||
FunctionalTestSetupTrait::initKernel | protected | function | Initializes the kernel after installation. | ||||
FunctionalTestSetupTrait::initSettings | protected | function | Initialize settings created during install. | ||||
FunctionalTestSetupTrait::initUserSession | protected | function | Initializes user 1 for the site to be installed. | ||||
FunctionalTestSetupTrait::installDefaultThemeFromClassProperty | protected | function | Installs the default theme defined by `static::$defaultTheme` when needed. | 1 | |||
FunctionalTestSetupTrait::installModulesFromClassProperty | protected | function | Install modules defined by `static::$modules`. | 1 | |||
FunctionalTestSetupTrait::installParameters | protected | function | Returns the parameters that will be used when the test installs Drupal. | 8 | |||
FunctionalTestSetupTrait::prepareEnvironment | protected | function | Prepares the current environment for running the test. | 28 | |||
FunctionalTestSetupTrait::prepareRequestForGenerator | protected | function | Creates a mock request and sets it on the generator. | ||||
FunctionalTestSetupTrait::prepareSettings | protected | function | Prepares site settings and services before installation. | 4 | |||
FunctionalTestSetupTrait::rebuildAll | protected | function | Resets and rebuilds the environment after setup. | ||||
FunctionalTestSetupTrait::rebuildContainer | protected | function | Rebuilds \Drupal::getContainer(). | ||||
FunctionalTestSetupTrait::resetAll | protected | function | Resets all data structures after having enabled new modules. | ||||
FunctionalTestSetupTrait::setContainerParameter | protected | function | Changes parameters in the services.yml file. | ||||
FunctionalTestSetupTrait::setupBaseUrl | protected | function | Sets up the base URL based upon the environment variable. | ||||
FunctionalTestSetupTrait::writeSettings | protected | function | Rewrites the settings.php file of the test site. | 1 | |||
NodeCreationTrait::createNode | protected | function | Creates a node based on default settings. | Aliased as: drupalCreateNode | |||
NodeCreationTrait::getNodeByTitle | public | function | Get a node from the database based on its title. | Aliased as: drupalGetNodeByTitle | |||
OptionsWidgetsTest::$card1 | protected | property | A field storage with cardinality 1 to use in this test class. | ||||
OptionsWidgetsTest::$card2 | protected | property | A field storage with cardinality 2 to use in this test class. | ||||
OptionsWidgetsTest::$defaultTheme | protected | property | The theme to install as the default for testing. | Overrides BrowserTestBase::$defaultTheme | |||
OptionsWidgetsTest::$float | protected | property | A field storage with float values to use in this test class. | ||||
OptionsWidgetsTest::$modules | protected static | property | Modules to install. | Overrides BrowserTestBase::$modules | |||
OptionsWidgetsTest::setUp | protected | function | Overrides BrowserTestBase::setUp | ||||
OptionsWidgetsTest::testCheckBoxes | public | function | Tests the 'options_buttons' widget (multiple select). | ||||
OptionsWidgetsTest::testEmptyValue | public | function | Tests the 'options_select' and 'options_button' widget for empty value. | ||||
OptionsWidgetsTest::testOptionsListAlter | public | function | Tests hook_options_list_alter(). | ||||
OptionsWidgetsTest::testRadioButtons | public | function | Tests the 'options_buttons' widget (single select). | ||||
OptionsWidgetsTest::testSelectListFloat | public | function | Tests the 'options_select' widget (float values). | ||||
OptionsWidgetsTest::testSelectListMultiple | public | function | Tests the 'options_select' widget (multiple select). | ||||
OptionsWidgetsTest::testSelectListRequiredErrorAttribute | public | function | Tests the '#required_error' attribute for the select list. | ||||
OptionsWidgetsTest::testSelectListSingle | public | function | Tests the 'options_select' widget (single select). | ||||
PhpUnitWarnings::$deprecationWarnings | private static | property | Deprecation warnings from PHPUnit to raise with @trigger_error(). | ||||
PhpUnitWarnings::addWarning | public | function | Converts PHPUnit deprecation warnings to E_USER_DEPRECATED. | ||||
RandomGeneratorTrait::getRandomGenerator | protected | function | Gets the random generator for the utility methods. | ||||
RandomGeneratorTrait::randomMachineName | protected | function | Generates a unique random string containing letters and numbers. | ||||
RandomGeneratorTrait::randomObject | public | function | Generates a random PHP object. | ||||
RandomGeneratorTrait::randomString | public | function | Generates a pseudo-random string of ASCII characters of codes 32 to 126. | ||||
RandomGeneratorTrait::randomStringValidate | Deprecated | public | function | Callback for random string validation. | |||
RefreshVariablesTrait::refreshVariables | protected | function | Refreshes in-memory configuration and state information. | 2 | |||
SessionTestTrait::$sessionName | protected | property | The name of the session cookie. | ||||
SessionTestTrait::generateSessionName | protected | function | Generates a session cookie name. | ||||
SessionTestTrait::getSessionName | protected | function | Returns the session name in use on the child site. | ||||
StorageCopyTrait::replaceStorageContents | protected static | function | Copy the configuration from one storage to another and remove stale items. | ||||
TestRequirementsTrait::checkModuleRequirements | Deprecated | private | function | Checks missing module requirements. | |||
TestRequirementsTrait::checkRequirements | Deprecated | protected | function | Check module requirements for the Drupal use case. | |||
TestRequirementsTrait::getDrupalRoot | protected static | function | Returns the Drupal root directory. | ||||
TestSetupTrait::$configSchemaCheckerExclusions | protected static | property | An array of config object names that are excluded from schema checking. | 2 | |||
TestSetupTrait::$container | protected | property | The dependency injection container used in the test. | ||||
TestSetupTrait::$databasePrefix | protected | property | The database prefix of this test run. | ||||
TestSetupTrait::$kernel | protected | property | The DrupalKernel instance used in the test. | ||||
TestSetupTrait::$originalSite | protected | property | The site directory of the original parent site. | ||||
TestSetupTrait::$privateFilesDirectory | protected | property | The private file directory for the test environment. | ||||
TestSetupTrait::$publicFilesDirectory | protected | property | The public file directory for the test environment. | ||||
TestSetupTrait::$root | protected | property | The app root. | ||||
TestSetupTrait::$siteDirectory | protected | property | The site directory of this test run. | ||||
TestSetupTrait::$strictConfigSchema | protected | property | Set to TRUE to strict check all configuration saved. | 4 | |||
TestSetupTrait::$tempFilesDirectory | protected | property | The temporary file directory for the test environment. | ||||
TestSetupTrait::$testId | protected | property | The test run ID. | ||||
TestSetupTrait::changeDatabasePrefix | protected | function | Changes the database connection to the prefixed one. | ||||
TestSetupTrait::getConfigSchemaExclusions | protected | function | Gets the config schema exclusions for this test. | ||||
TestSetupTrait::getDatabaseConnection | Deprecated | public static | function | Returns the database connection to the site under test. | |||
TestSetupTrait::prepareDatabasePrefix | protected | function | Generates a database prefix for running tests. | 1 | |||
UiHelperTrait::$loggedInUser | protected | property | The current user logged in using the Mink controlled browser. | ||||
UiHelperTrait::$maximumMetaRefreshCount | protected | property | The number of meta refresh redirects to follow, or NULL if unlimited. | ||||
UiHelperTrait::$metaRefreshCount | protected | property | The number of meta refresh redirects followed during ::drupalGet(). | ||||
UiHelperTrait::$useOneTimeLoginLinks | protected | property | Use one-time login links instead of submitting the login form. | 3 | |||
UiHelperTrait::assertSession | public | function | Returns WebAssert object. | 1 | |||
UiHelperTrait::buildUrl | protected | function | Builds an absolute URL from a system path or a URL object. | ||||
UiHelperTrait::checkForMetaRefresh | protected | function | Checks for meta refresh tag and if found call drupalGet() recursively. | ||||
UiHelperTrait::click | protected | function | Clicks the element with the given CSS selector. | ||||
UiHelperTrait::clickLink | protected | function | Follows a link by complete name. | ||||
UiHelperTrait::cssSelect | protected | function | Searches elements using a CSS selector in the raw content. | ||||
UiHelperTrait::cssSelectToXpath | protected | function | Translates a CSS expression to its XPath equivalent. | ||||
UiHelperTrait::drupalGet | protected | function | Retrieves a Drupal path or an absolute path. | 3 | |||
UiHelperTrait::drupalLogin | protected | function | Logs in a user using the Mink controlled browser. | ||||
UiHelperTrait::drupalLogout | protected | function | Logs a user out of the Mink controlled browser and confirms. | ||||
UiHelperTrait::drupalResetSession | protected | function | Resets the current active session back to Anonymous session. | ||||
UiHelperTrait::drupalUserIsLoggedIn | protected | function | Returns whether a given user account is logged in. | ||||
UiHelperTrait::getAbsoluteUrl | protected | function | Takes a path and returns an absolute path. | ||||
UiHelperTrait::getTextContent | protected | function | Retrieves the plain-text content from the current page. | ||||
UiHelperTrait::getUrl | protected | function | Get the current URL from the browser. | ||||
UiHelperTrait::isTestUsingGuzzleClient | protected | function | Determines if test is using DrupalTestBrowser. | ||||
UiHelperTrait::prepareRequest | protected | function | Prepare for a request to testing site. | 1 | |||
UiHelperTrait::submitForm | protected | function | Fills and submits a form. | ||||
UserCreationTrait::checkPermissions | protected | function | Checks whether a given list of permission names is valid. | ||||
UserCreationTrait::createAdminRole | protected | function | Creates an administrative role. | ||||
UserCreationTrait::createRole | protected | function | Creates a role with specified permissions. | Aliased as: drupalCreateRole | |||
UserCreationTrait::createUser | protected | function | Create a user with a given set of permissions. | Aliased as: drupalCreateUser | |||
UserCreationTrait::grantPermissions | protected | function | Grant permissions to a user role. | ||||
UserCreationTrait::setCurrentUser | protected | function | Switch the current logged in user. | ||||
UserCreationTrait::setUpCurrentUser | protected | function | Creates a random user account and sets it as current user. | ||||
XdebugRequestTrait::extractCookiesFromRequest | protected | function | Adds xdebug cookies, from request setup. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.