class OptionsFieldUITest

Same name in this branch
  1. 10 core/modules/options/tests/src/FunctionalJavascript/OptionsFieldUITest.php \Drupal\Tests\options\FunctionalJavascript\OptionsFieldUITest
Same name in other branches
  1. 9 core/modules/options/tests/src/Functional/OptionsFieldUITest.php \Drupal\Tests\options\Functional\OptionsFieldUITest
  2. 8.9.x core/modules/options/tests/src/Functional/OptionsFieldUITest.php \Drupal\Tests\options\Functional\OptionsFieldUITest
  3. 11.x core/modules/options/tests/src/FunctionalJavascript/OptionsFieldUITest.php \Drupal\Tests\options\FunctionalJavascript\OptionsFieldUITest
  4. 11.x core/modules/options/tests/src/Functional/OptionsFieldUITest.php \Drupal\Tests\options\Functional\OptionsFieldUITest

Tests the Options field UI functionality.

@group options @group #slow

Hierarchy

Expanded class hierarchy of OptionsFieldUITest

File

core/modules/options/tests/src/Functional/OptionsFieldUITest.php, line 17

Namespace

Drupal\Tests\options\Functional
View source
class OptionsFieldUITest extends FieldTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'node',
        'options',
        'field_test',
        'taxonomy',
        'field_ui',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * The name of the created content type.
     *
     * @var string
     */
    protected $typeName;
    
    /**
     * Machine name of the created content type.
     *
     * @var string
     */
    protected $type;
    
    /**
     * Name of the option field.
     *
     * @var string
     */
    protected $fieldName;
    
    /**
     * Admin path to manage field storage settings.
     *
     * @var string
     */
    protected $adminPath;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp() : void {
        parent::setUp();
        // Create test user.
        $admin_user = $this->drupalCreateUser([
            'access content',
            'administer taxonomy',
            'access administration pages',
            'administer site configuration',
            'administer content types',
            'administer nodes',
            'bypass node access',
            'administer node fields',
            'administer node display',
        ]);
        $this->drupalLogin($admin_user);
        // Create content type, with underscores.
        $this->typeName = 'test_' . $this->randomMachineName();
        $type = $this->drupalCreateContentType([
            'name' => $this->typeName,
            'type' => $this->typeName,
        ]);
        $this->type = $type->id();
    }
    
    /**
     * Options (integer) : test 'allowed values' input.
     */
    public function testOptionsAllowedValuesInteger() : void {
        $this->fieldName = 'field_options_integer';
        $this->createOptionsField('list_integer');
        $page = $this->getSession()
            ->getPage();
        $assert_session = $this->assertSession();
        // Explicit integer keys.
        $input = [
            'field_storage[subform][settings][allowed_values][table][0][item][key]' => 0,
            'field_storage[subform][settings][allowed_values][table][0][item][label]' => 'Zero',
            'field_storage[subform][settings][allowed_values][table][1][item][key]' => 2,
            'field_storage[subform][settings][allowed_values][table][1][item][label]' => 'Two',
        ];
        $array = [
            0 => 'Zero',
            2 => 'Two',
        ];
        $this->assertAllowedValuesInput($input, $array, 'Integer keys are accepted.');
        // Non-integer keys.
        $input = [
            'field_storage[subform][settings][allowed_values][table][0][item][key]' => 1.1,
            'field_storage[subform][settings][allowed_values][table][0][item][label]' => 'One',
        ];
        $this->assertAllowedValuesInput($input, 'keys must be integers', 'Non integer keys are rejected.');
        $input = [
            'field_storage[subform][settings][allowed_values][table][0][item][key]' => 'abc',
            'field_storage[subform][settings][allowed_values][table][0][item][label]' => 'abc',
        ];
        $this->assertAllowedValuesInput($input, 'keys must be integers', 'Non integer keys are rejected.');
        $input = [
            'field_storage[subform][settings][allowed_values][table][0][item][key]' => 0,
            'field_storage[subform][settings][allowed_values][table][0][item][label]' => 'Zero',
            'field_storage[subform][settings][allowed_values][table][1][item][key]' => 1,
            'field_storage[subform][settings][allowed_values][table][1][item][label]' => 'One',
        ];
        $array = [
            0 => 'Zero',
            1 => 'One',
        ];
        $this->assertAllowedValuesInput($input, $array, '');
        // Create a node with actual data for the field.
        $settings = [
            'type' => $this->type,
            $this->fieldName => [
                [
                    'value' => 1,
                ],
            ],
        ];
        $node = $this->drupalCreateNode($settings);
        // Check that the values in use cannot be removed.
        $this->drupalGet($this->adminPath);
        $assert_session->elementExists('css', '#remove_row_button__1');
        $delete_button_1 = $page->findById('remove_row_button__1');
        $this->assertTrue($delete_button_1->hasAttribute('disabled'), 'Button is disabled');
        // Delete the node, remove the value.
        $node->delete();
        $this->drupalGet($this->adminPath);
        $delete_button_1->click();
        $assert_session->pageTextNotContains('Processing...');
        $page->findById('edit-submit')
            ->click();
        $field_storage = FieldStorageConfig::loadByName('node', $this->fieldName);
        $this->assertSame($field_storage->getSetting('allowed_values'), [
            0 => 'Zero',
        ]);
        // Check that the same key can only be used once.
        $input = [
            'field_storage[subform][settings][allowed_values][table][0][item][key]' => 0,
            'field_storage[subform][settings][allowed_values][table][0][item][label]' => 'Zero',
            'field_storage[subform][settings][allowed_values][table][1][item][key]' => 0,
            'field_storage[subform][settings][allowed_values][table][1][item][label]' => 'One',
        ];
        $array = [
            '0' => 'One',
        ];
        $this->assertAllowedValuesInput($input, $array, 'Same value cannot be used multiple times.');
    }
    
    /**
     * Options (float) : test 'allowed values' input.
     */
    public function testOptionsAllowedValuesFloat() : void {
        $this->fieldName = 'field_options_float';
        $this->createOptionsField('list_float');
        $page = $this->getSession()
            ->getPage();
        $assert_session = $this->assertSession();
        // Explicit numeric keys.
        $input = [
            'field_storage[subform][settings][allowed_values][table][0][item][key]' => 0,
            'field_storage[subform][settings][allowed_values][table][0][item][label]' => 'Zero',
            'field_storage[subform][settings][allowed_values][table][1][item][key]' => 0.5,
            'field_storage[subform][settings][allowed_values][table][1][item][label]' => 'Point five',
        ];
        $array = [
            '0' => 'Zero',
            '0.5' => 'Point five',
        ];
        $this->assertAllowedValuesInput($input, $array, 'Integer keys are accepted.');
        // Check that values can be added.
        $input = [
            'field_storage[subform][settings][allowed_values][table][0][item][key]' => 0,
            'field_storage[subform][settings][allowed_values][table][0][item][label]' => 'Zero',
            'field_storage[subform][settings][allowed_values][table][1][item][key]' => 0.5,
            'field_storage[subform][settings][allowed_values][table][1][item][label]' => 'Point five',
            'field_storage[subform][settings][allowed_values][table][2][item][key]' => 1,
            'field_storage[subform][settings][allowed_values][table][2][item][label]' => 'One',
        ];
        $array = [
            '0' => 'Zero',
            '0.5' => 'Point five',
            '1' => 'One',
        ];
        $this->assertAllowedValuesInput($input, $array, 'Values can be added.');
        // Non-numeric keys.
        $input = [
            'field_storage[subform][settings][allowed_values][table][0][item][key]' => 'abc',
            'field_storage[subform][settings][allowed_values][table][0][item][label]' => 'abc',
        ];
        $this->assertAllowedValuesInput($input, 'each key must be a valid integer or decimal', 'Non numeric keys are rejected.');
        $input = [
            'field_storage[subform][settings][allowed_values][table][0][item][key]' => 0,
            'field_storage[subform][settings][allowed_values][table][0][item][label]' => 'Zero',
            'field_storage[subform][settings][allowed_values][table][1][item][key]' => 0.5,
            'field_storage[subform][settings][allowed_values][table][1][item][label]' => 'Point five',
            'field_storage[subform][settings][allowed_values][table][2][item][key]' => 2,
            'field_storage[subform][settings][allowed_values][table][2][item][label]' => 'Two',
        ];
        $array = [
            '0' => 'Zero',
            '0.5' => 'Point five',
            '2' => 'Two',
        ];
        $this->assertAllowedValuesInput($input, $array, '');
        // Create a node with actual data for the field.
        $settings = [
            'type' => $this->type,
            $this->fieldName => [
                [
                    'value' => 0.5,
                ],
            ],
        ];
        $node = $this->drupalCreateNode($settings);
        // Check that the values in use cannot be removed.
        $this->drupalGet($this->adminPath);
        $assert_session->elementExists('css', '#remove_row_button__1');
        $delete_button_1 = $page->findById('remove_row_button__1');
        $this->assertTrue($delete_button_1->hasAttribute('disabled'), 'Button is disabled');
        // Delete the node, remove the value.
        $node->delete();
        $this->drupalGet($this->adminPath);
        $delete_button_1->click();
        $assert_session->pageTextNotContains('Processing...');
        $page->findById('edit-submit')
            ->click();
        $field_storage = FieldStorageConfig::loadByName('node', $this->fieldName);
        $this->assertSame($field_storage->getSetting('allowed_values'), [
            0 => 'Zero',
            2 => 'Two',
        ]);
        $input = [
            'field_storage[subform][settings][allowed_values][table][0][item][key]' => 0.5,
            'field_storage[subform][settings][allowed_values][table][0][item][label]' => 'Point five',
            'field_storage[subform][settings][allowed_values][table][1][item][key]' => 0.5,
            'field_storage[subform][settings][allowed_values][table][1][item][label]' => 'Half',
        ];
        $array = [
            '0.5' => 'Half',
        ];
        $this->assertAllowedValuesInput($input, $array, 'Same value cannot be used multiple times.');
        // Check that different forms of the same float value cannot be used.
        $input = [
            'field_storage[subform][settings][allowed_values][table][0][item][key]' => 0.5,
            'field_storage[subform][settings][allowed_values][table][0][item][label]' => 'Point five',
            'field_storage[subform][settings][allowed_values][table][1][item][key]' => 0.5,
            'field_storage[subform][settings][allowed_values][table][1][item][label]' => 'Half',
        ];
        $array = [
            '0.5' => 'Half',
        ];
        $this->assertAllowedValuesInput($input, $array, 'Different forms of the same value cannot be used.');
    }
    
    /**
     * Options (text) : test 'allowed values' input.
     */
    public function testOptionsAllowedValuesText() : void {
        $this->fieldName = 'field_options_text';
        $this->createOptionsField('list_string');
        $page = $this->getSession()
            ->getPage();
        $assert_session = $this->assertSession();
        // Explicit keys.
        $input = [
            'field_storage[subform][settings][allowed_values][table][0][item][key]' => '_zero',
            'field_storage[subform][settings][allowed_values][table][0][item][label]' => 'Zero',
            'field_storage[subform][settings][allowed_values][table][1][item][key]' => '_one',
            'field_storage[subform][settings][allowed_values][table][1][item][label]' => 'One',
        ];
        $array = [
            '_zero' => 'Zero',
            '_one' => 'One',
        ];
        $this->assertAllowedValuesInput($input, $array, 'Explicit keys are accepted.');
        // Overly long keys.
        $input = [
            'field_storage[subform][settings][allowed_values][table][0][item][key]' => 'zero',
            'field_storage[subform][settings][allowed_values][table][0][item][label]' => 'Zero',
            'field_storage[subform][settings][allowed_values][table][1][item][key]' => $this->randomMachineName(256),
            'field_storage[subform][settings][allowed_values][table][1][item][label]' => 'One',
        ];
        $this->assertAllowedValuesInput($input, 'each key must be a string at most 255 characters long', 'Overly long keys are rejected.');
        $input = [
            'field_storage[subform][settings][allowed_values][table][0][item][key]' => 'zero',
            'field_storage[subform][settings][allowed_values][table][0][item][label]' => 'Zero',
            'field_storage[subform][settings][allowed_values][table][1][item][key]' => 'one',
            'field_storage[subform][settings][allowed_values][table][1][item][label]' => 'One',
        ];
        $array = [
            'zero' => 'Zero',
            'one' => 'One',
        ];
        $this->assertAllowedValuesInput($input, $array, '');
        // Create a node with actual data for the field.
        $settings = [
            'type' => $this->type,
            $this->fieldName => [
                [
                    'value' => 'one',
                ],
            ],
        ];
        $node = $this->drupalCreateNode($settings);
        // Check that the values in use cannot be removed.
        $this->drupalGet($this->adminPath);
        $assert_session->elementExists('css', '#remove_row_button__1');
        $delete_button_1 = $page->findById('remove_row_button__1');
        $value_field_1 = $page->findField('field_storage[subform][settings][allowed_values][table][1][item][key]');
        $this->assertTrue($delete_button_1->hasAttribute('disabled'), 'Button is disabled');
        $this->assertTrue($value_field_1->hasAttribute('disabled'), 'Button is disabled');
        // Delete the node, remove the value.
        $node->delete();
        $this->drupalGet($this->adminPath);
        $delete_button_1->click();
        $assert_session->pageTextNotContains('Processing...');
        $page->findById('edit-submit')
            ->click();
        $field_storage = FieldStorageConfig::loadByName('node', $this->fieldName);
        $this->assertSame($field_storage->getSetting('allowed_values'), [
            'zero' => 'Zero',
        ]);
        // Check that string values with special characters can be used.
        $input = [
            'field_storage[subform][settings][allowed_values][table][0][item][key]' => 'zero',
            'field_storage[subform][settings][allowed_values][table][0][item][label]' => 'Zero',
            'field_storage[subform][settings][allowed_values][table][1][item][key]' => '.example #example',
            'field_storage[subform][settings][allowed_values][table][1][item][label]' => 'Example',
        ];
        $array = [
            'zero' => 'Zero',
            '.example #example' => 'Example',
        ];
        $this->assertAllowedValuesInput($input, $array, '');
        // Check that the same key can only be used once.
        $input = [
            'field_storage[subform][settings][allowed_values][table][0][item][key]' => 'zero',
            'field_storage[subform][settings][allowed_values][table][0][item][label]' => 'Zero',
            'field_storage[subform][settings][allowed_values][table][1][item][key]' => 'zero',
            'field_storage[subform][settings][allowed_values][table][1][item][label]' => 'One',
        ];
        $array = [
            'zero' => 'One',
        ];
        $this->assertAllowedValuesInput($input, $array, 'Same value cannot be used multiple times.');
    }
    
    /**
     * Helper function to create list field of a given type.
     *
     * @param string $type
     *   One of 'list_integer', 'list_float' or 'list_string'.
     */
    protected function createOptionsField($type) {
        // Create a field.
        FieldStorageConfig::create([
            'field_name' => $this->fieldName,
            'entity_type' => 'node',
            'type' => $type,
        ])
            ->save();
        FieldConfig::create([
            'field_name' => $this->fieldName,
            'entity_type' => 'node',
            'bundle' => $this->type,
        ])
            ->save();
        \Drupal::service('entity_display.repository')->getFormDisplay('node', $this->type)
            ->setComponent($this->fieldName)
            ->save();
        $this->adminPath = 'admin/structure/types/manage/' . $this->type . '/fields/node.' . $this->type . '.' . $this->fieldName;
    }
    
    /**
     * Tests an input array for the 'allowed values' form element.
     *
     * @param array $input
     *   The input array.
     * @param array|string $result
     *   Either an expected resulting array in
     *   $field->getSetting('allowed_values'), or an expected error message.
     * @param string $message
     *   Message to display.
     *
     * @internal
     */
    public function assertAllowedValuesInput(array $input, $result, string $message) : void {
        $this->drupalGet($this->adminPath);
        $page = $this->getSession()
            ->getPage();
        $add_button = $page->findButton('Add another item');
        $add_button->click();
        $add_button->click();
        $this->submitForm($input, 'Save');
        // Verify that the page does not have double escaped HTML tags.
        $this->assertSession()
            ->responseNotContains('<');
        if (is_string($result)) {
            $this->assertSession()
                ->pageTextContains($result);
        }
        else {
            $field_storage = FieldStorageConfig::loadByName('node', $this->fieldName);
            $this->assertSame($field_storage->getSetting('allowed_values'), $result, $message);
        }
    }
    
    /**
     * Tests normal and key formatter display on node display.
     */
    public function testNodeDisplay() : void {
        $this->fieldName = $this->randomMachineName();
        $this->createOptionsField('list_integer');
        $node = $this->drupalCreateNode([
            'type' => $this->type,
        ]);
        $on = $this->randomMachineName();
        $off = $this->randomMachineName();
        $edit = [
            'field_storage[subform][settings][allowed_values][table][0][item][key]' => 1,
            'field_storage[subform][settings][allowed_values][table][0][item][label]' => $on,
            'field_storage[subform][settings][allowed_values][table][1][item][key]' => 0,
            'field_storage[subform][settings][allowed_values][table][1][item][label]' => $off,
        ];
        $this->drupalGet($this->adminPath);
        $page = $this->getSession()
            ->getPage();
        $page->findButton('Add another item')
            ->click();
        $this->submitForm($edit, 'Save');
        // Select a default value.
        $edit = [
            $this->fieldName => '1',
        ];
        $this->drupalGet('node/' . $node->id() . '/edit');
        $this->submitForm($edit, 'Save');
        // Check the node page and see if the values are correct.
        $file_formatters = [
            'list_default',
            'list_key',
        ];
        foreach ($file_formatters as $formatter) {
            $edit = [
                "fields[{$this->fieldName}][type]" => $formatter,
                "fields[{$this->fieldName}][region]" => 'content',
            ];
            $this->drupalGet('admin/structure/types/manage/' . $this->typeName . '/display');
            $this->submitForm($edit, 'Save');
            $this->drupalGet('node/' . $node->id());
            if ($formatter == 'list_default') {
                $output = $on;
            }
            else {
                $output = '1';
            }
            // Verify that correct options are found.
            $this->assertSession()
                ->elementsCount('xpath', '//div[text()="' . $output . '"]', 1);
        }
    }
    
    /**
     * Confirms the allowed value list is a required field.
     */
    public function testRequiredPropertyForAllowedValuesList() : void {
        $field_types = [
            'list_float',
            'list_string',
            'list_integer',
        ];
        foreach ($field_types as $field_type) {
            $this->fieldName = "field_options_{$field_type}";
            $this->createOptionsField($field_type);
            $page = $this->getSession()
                ->getPage();
            $this->drupalGet($this->adminPath);
            // Assert that the delete button for a single row is disabled.
            $this->assertCount(1, $page->findAll('css', '#allowed-values-order tr.draggable'));
            $delete_button_0 = $page->findById('remove_row_button__0');
            $this->assertTrue($delete_button_0->hasAttribute('disabled'), 'Button is disabled');
            $page->findButton('Add another item')
                ->click();
            // Assert that the delete button for the first row is enabled if there are
            // more that one rows.
            $this->assertCount(2, $page->findAll('css', '#allowed-values-order tr.draggable'));
            $this->assertFalse($delete_button_0->hasAttribute('disabled'), 'Button is enabled');
            // Delete a row.
            $delete_button_0->click();
            // Assert that the button is disabled again.
            $this->assertTrue($delete_button_0->hasAttribute('disabled'), 'Button is disabled');
            // Try to proceed without entering any value.
            $page->findButton('Save')
                ->click();
            if ($field_type == 'list_string') {
                // Asserting only name field as there is no value field for list_string.
                $this->assertSession()
                    ->pageTextContains('Name field is required.');
            }
            else {
                // Confirmation message that name and value are required fields for
                // list_float and list_integer.
                $this->assertSession()
                    ->pageTextContains('Name field is required.');
                $this->assertSession()
                    ->pageTextContains('Value field is required.');
            }
        }
    }

}

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
OptionsFieldUITest::$adminPath protected property Admin path to manage field storage settings.
OptionsFieldUITest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
OptionsFieldUITest::$fieldName protected property Name of the option field.
OptionsFieldUITest::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules
OptionsFieldUITest::$type protected property Machine name of the created content type.
OptionsFieldUITest::$typeName protected property The name of the created content type.
OptionsFieldUITest::assertAllowedValuesInput public function Tests an input array for the 'allowed values' form element.
OptionsFieldUITest::createOptionsField protected function Helper function to create list field of a given type.
OptionsFieldUITest::setUp protected function Overrides BrowserTestBase::setUp
OptionsFieldUITest::testNodeDisplay public function Tests normal and key formatter display on node display.
OptionsFieldUITest::testOptionsAllowedValuesFloat public function Options (float) : test 'allowed values' input.
OptionsFieldUITest::testOptionsAllowedValuesInteger public function Options (integer) : test 'allowed values' input.
OptionsFieldUITest::testOptionsAllowedValuesText public function Options (text) : test 'allowed values' input.
OptionsFieldUITest::testRequiredPropertyForAllowedValuesList public function Confirms the allowed value list is a required field.
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.