class NumberFieldTest

Same name in this branch
  1. 8.9.x core/modules/field/tests/src/FunctionalJavascript/Number/NumberFieldTest.php \Drupal\Tests\field\FunctionalJavascript\Number\NumberFieldTest
Same name and namespace in other branches
  1. 9 core/modules/field/tests/src/FunctionalJavascript/Number/NumberFieldTest.php \Drupal\Tests\field\FunctionalJavascript\Number\NumberFieldTest
  2. 9 core/modules/field/tests/src/Functional/Number/NumberFieldTest.php \Drupal\Tests\field\Functional\Number\NumberFieldTest
  3. 10 core/modules/field/tests/src/FunctionalJavascript/Number/NumberFieldTest.php \Drupal\Tests\field\FunctionalJavascript\Number\NumberFieldTest
  4. 10 core/modules/field/tests/src/Functional/Number/NumberFieldTest.php \Drupal\Tests\field\Functional\Number\NumberFieldTest
  5. 11.x core/modules/field/tests/src/FunctionalJavascript/Number/NumberFieldTest.php \Drupal\Tests\field\FunctionalJavascript\Number\NumberFieldTest
  6. 11.x core/modules/field/tests/src/Functional/Number/NumberFieldTest.php \Drupal\Tests\field\Functional\Number\NumberFieldTest

Tests the creation of numeric fields.

@group field

Hierarchy

Expanded class hierarchy of NumberFieldTest

File

core/modules/field/tests/src/Functional/Number/NumberFieldTest.php, line 14

Namespace

Drupal\Tests\field\Functional\Number
View source
class NumberFieldTest extends BrowserTestBase {
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    public static $modules = [
        'node',
        'entity_test',
        'field_ui',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    protected function setUp() {
        parent::setUp();
        $this->drupalLogin($this->drupalCreateUser([
            'view test entity',
            'administer entity_test content',
            'administer content types',
            'administer node fields',
            'administer node display',
            'bypass node access',
            'administer entity_test fields',
        ]));
    }
    
    /**
     * Test decimal field.
     */
    public function testNumberDecimalField() {
        // Create a field with settings to validate.
        $field_name = mb_strtolower($this->randomMachineName());
        FieldStorageConfig::create([
            'field_name' => $field_name,
            'entity_type' => 'entity_test',
            'type' => 'decimal',
            'settings' => [
                'precision' => 8,
                'scale' => 4,
            ],
        ])->save();
        FieldConfig::create([
            'field_name' => $field_name,
            'entity_type' => 'entity_test',
            'bundle' => 'entity_test',
        ])->save();
        
        /** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */
        $display_repository = \Drupal::service('entity_display.repository');
        $display_repository->getFormDisplay('entity_test', 'entity_test')
            ->setComponent($field_name, [
            'type' => 'number',
            'settings' => [
                'placeholder' => '0.00',
            ],
        ])
            ->save();
        $display_repository->getViewDisplay('entity_test', 'entity_test')
            ->setComponent($field_name, [
            'type' => 'number_decimal',
        ])
            ->save();
        // Display creation form.
        $this->drupalGet('entity_test/add');
        $this->assertFieldByName("{$field_name}[0][value]", '', 'Widget is displayed');
        $this->assertRaw('placeholder="0.00"');
        // Submit a signed decimal value within the allowed precision and scale.
        $value = '-1234.5678';
        $edit = [
            "{$field_name}[0][value]" => $value,
        ];
        $this->drupalPostForm(NULL, $edit, t('Save'));
        preg_match('|entity_test/manage/(\\d+)|', $this->getUrl(), $match);
        $id = $match[1];
        $this->assertText(t('entity_test @id has been created.', [
            '@id' => $id,
        ]), 'Entity was created');
        $this->assertRaw($value, 'Value is displayed.');
        // Try to create entries with more than one decimal separator; assert fail.
        $wrong_entries = [
            '3.14.159',
            '0..45469',
            '..4589',
            '6.459.52',
            '6.3..25',
        ];
        foreach ($wrong_entries as $wrong_entry) {
            $this->drupalGet('entity_test/add');
            $edit = [
                "{$field_name}[0][value]" => $wrong_entry,
            ];
            $this->drupalPostForm(NULL, $edit, t('Save'));
            $this->assertRaw(t('%name must be a number.', [
                '%name' => $field_name,
            ]), 'Correctly failed to save decimal value with more than one decimal point.');
        }
        // Try to create entries with minus sign not in the first position.
        $wrong_entries = [
            '3-3',
            '4-',
            '1.3-',
            '1.2-4',
            '-10-10',
        ];
        foreach ($wrong_entries as $wrong_entry) {
            $this->drupalGet('entity_test/add');
            $edit = [
                "{$field_name}[0][value]" => $wrong_entry,
            ];
            $this->drupalPostForm(NULL, $edit, t('Save'));
            $this->assertRaw(t('%name must be a number.', [
                '%name' => $field_name,
            ]), 'Correctly failed to save decimal value with minus sign in the wrong position.');
        }
    }
    
    /**
     * Test integer field.
     */
    public function testNumberIntegerField() {
        $minimum = rand(-4000, -2000);
        $maximum = rand(2000, 4000);
        // Create a field with settings to validate.
        $field_name = mb_strtolower($this->randomMachineName());
        $storage = FieldStorageConfig::create([
            'field_name' => $field_name,
            'entity_type' => 'entity_test',
            'type' => 'integer',
        ]);
        $storage->save();
        FieldConfig::create([
            'field_name' => $field_name,
            'entity_type' => 'entity_test',
            'bundle' => 'entity_test',
            'settings' => [
                'min' => $minimum,
                'max' => $maximum,
                'prefix' => 'ThePrefix',
            ],
        ])->save();
        
        /** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */
        $display_repository = \Drupal::service('entity_display.repository');
        $display_repository->getFormDisplay('entity_test', 'entity_test')
            ->setComponent($field_name, [
            'type' => 'number',
            'settings' => [
                'placeholder' => '4',
            ],
        ])
            ->save();
        $display_repository->getViewDisplay('entity_test', 'entity_test')
            ->setComponent($field_name, [
            'type' => 'number_integer',
            'settings' => [
                'prefix_suffix' => FALSE,
            ],
        ])
            ->save();
        // Check the storage schema.
        $expected = [
            'columns' => [
                'value' => [
                    'type' => 'int',
                    'unsigned' => '',
                    'size' => 'normal',
                ],
            ],
            'unique keys' => [],
            'indexes' => [],
            'foreign keys' => [],
        ];
        $this->assertEqual($storage->getSchema(), $expected);
        // Display creation form.
        $this->drupalGet('entity_test/add');
        $this->assertFieldByName("{$field_name}[0][value]", '', 'Widget is displayed');
        $this->assertRaw('placeholder="4"');
        // Submit a valid integer
        $value = rand($minimum, $maximum);
        $edit = [
            "{$field_name}[0][value]" => $value,
        ];
        $this->drupalPostForm(NULL, $edit, t('Save'));
        preg_match('|entity_test/manage/(\\d+)|', $this->getUrl(), $match);
        $id = $match[1];
        $this->assertText(t('entity_test @id has been created.', [
            '@id' => $id,
        ]), 'Entity was created');
        // Try to set a value below the minimum value
        $this->drupalGet('entity_test/add');
        $edit = [
            "{$field_name}[0][value]" => $minimum - 1,
        ];
        $this->drupalPostForm(NULL, $edit, t('Save'));
        $this->assertRaw(t('%name must be higher than or equal to %minimum.', [
            '%name' => $field_name,
            '%minimum' => $minimum,
        ]), 'Correctly failed to save integer value less than minimum allowed value.');
        // Try to set a decimal value
        $this->drupalGet('entity_test/add');
        $edit = [
            "{$field_name}[0][value]" => 1.5,
        ];
        $this->drupalPostForm(NULL, $edit, t('Save'));
        $this->assertRaw(t('%name is not a valid number.', [
            '%name' => $field_name,
        ]), 'Correctly failed to save decimal value to integer field.');
        // Try to set a value above the maximum value
        $this->drupalGet('entity_test/add');
        $edit = [
            "{$field_name}[0][value]" => $maximum + 1,
        ];
        $this->drupalPostForm(NULL, $edit, t('Save'));
        $this->assertRaw(t('%name must be lower than or equal to %maximum.', [
            '%name' => $field_name,
            '%maximum' => $maximum,
        ]), 'Correctly failed to save integer value greater than maximum allowed value.');
        // Try to set a wrong integer value.
        $this->drupalGet('entity_test/add');
        $edit = [
            "{$field_name}[0][value]" => '20-40',
        ];
        $this->drupalPostForm(NULL, $edit, t('Save'));
        $this->assertRaw(t('%name must be a number.', [
            '%name' => $field_name,
        ]), 'Correctly failed to save wrong integer value.');
        // Test with valid entries.
        $valid_entries = [
            '-1234',
            '0',
            '1234',
        ];
        foreach ($valid_entries as $valid_entry) {
            $this->drupalGet('entity_test/add');
            $edit = [
                "{$field_name}[0][value]" => $valid_entry,
            ];
            $this->drupalPostForm(NULL, $edit, t('Save'));
            preg_match('|entity_test/manage/(\\d+)|', $this->getUrl(), $match);
            $id = $match[1];
            $this->assertText(t('entity_test @id has been created.', [
                '@id' => $id,
            ]), 'Entity was created');
            $this->assertRaw($valid_entry, 'Value is displayed.');
            $this->assertNoFieldByXpath('//div[@content="' . $valid_entry . '"]', NULL, 'The "content" attribute is not present since the Prefix is not being displayed');
        }
        // Test for the content attribute when a Prefix is displayed. Presumably this also tests for the attribute when a Suffix is displayed.
        $display_repository->getViewDisplay('entity_test', 'entity_test')
            ->setComponent($field_name, [
            'type' => 'number_integer',
            'settings' => [
                'prefix_suffix' => TRUE,
            ],
        ])
            ->save();
        $integer_value = '123';
        $this->drupalGet('entity_test/add');
        $edit = [
            "{$field_name}[0][value]" => $integer_value,
        ];
        $this->drupalPostForm(NULL, $edit, t('Save'));
        preg_match('|entity_test/manage/(\\d+)|', $this->getUrl(), $match);
        $id = $match[1];
        $this->assertText(t('entity_test @id has been created.', [
            '@id' => $id,
        ]), 'Entity was created');
        $this->drupalGet('entity_test/' . $id);
        $this->assertFieldByXPath('//div[@content="' . $integer_value . '"]', 'ThePrefix' . $integer_value, 'The "content" attribute has been set to the value of the field, and the prefix is being displayed.');
    }
    
    /**
     * Test float field.
     */
    public function testNumberFloatField() {
        // Create a field with settings to validate.
        $field_name = mb_strtolower($this->randomMachineName());
        FieldStorageConfig::create([
            'field_name' => $field_name,
            'entity_type' => 'entity_test',
            'type' => 'float',
        ])->save();
        FieldConfig::create([
            'field_name' => $field_name,
            'entity_type' => 'entity_test',
            'bundle' => 'entity_test',
        ])->save();
        
        /** @var \Drupal\Core\Entity\EntityDisplayRepositoryInterface $display_repository */
        $display_repository = \Drupal::service('entity_display.repository');
        $display_repository->getFormDisplay('entity_test', 'entity_test')
            ->setComponent($field_name, [
            'type' => 'number',
            'settings' => [
                'placeholder' => '0.00',
            ],
        ])
            ->save();
        $display_repository->getViewDisplay('entity_test', 'entity_test')
            ->setComponent($field_name, [
            'type' => 'number_decimal',
        ])
            ->save();
        // Display creation form.
        $this->drupalGet('entity_test/add');
        $this->assertFieldByName("{$field_name}[0][value]", '', 'Widget is displayed');
        $this->assertRaw('placeholder="0.00"');
        // Submit a signed decimal value within the allowed precision and scale.
        $value = '-1234.5678';
        $edit = [
            "{$field_name}[0][value]" => $value,
        ];
        $this->drupalPostForm(NULL, $edit, t('Save'));
        preg_match('|entity_test/manage/(\\d+)|', $this->getUrl(), $match);
        $id = $match[1];
        $this->assertText(t('entity_test @id has been created.', [
            '@id' => $id,
        ]), 'Entity was created');
        // Ensure that the 'number_decimal' formatter displays the number with the
        // expected rounding.
        $this->drupalGet('entity_test/' . $id);
        $this->assertRaw(round($value, 2));
        // Try to create entries with more than one decimal separator; assert fail.
        $wrong_entries = [
            '3.14.159',
            '0..45469',
            '..4589',
            '6.459.52',
            '6.3..25',
        ];
        foreach ($wrong_entries as $wrong_entry) {
            $this->drupalGet('entity_test/add');
            $edit = [
                "{$field_name}[0][value]" => $wrong_entry,
            ];
            $this->drupalPostForm(NULL, $edit, t('Save'));
            $this->assertRaw(t('%name must be a number.', [
                '%name' => $field_name,
            ]), 'Correctly failed to save float value with more than one decimal point.');
        }
        // Try to create entries with minus sign not in the first position.
        $wrong_entries = [
            '3-3',
            '4-',
            '1.3-',
            '1.2-4',
            '-10-10',
        ];
        foreach ($wrong_entries as $wrong_entry) {
            $this->drupalGet('entity_test/add');
            $edit = [
                "{$field_name}[0][value]" => $wrong_entry,
            ];
            $this->drupalPostForm(NULL, $edit, t('Save'));
            $this->assertRaw(t('%name must be a number.', [
                '%name' => $field_name,
            ]), 'Correctly failed to save float value with minus sign in the wrong position.');
        }
    }
    
    /**
     * Tests setting the minimum value of a float field through the interface.
     */
    public function testCreateNumberFloatField() {
        // Create a float field.
        $field_name = mb_strtolower($this->randomMachineName());
        FieldStorageConfig::create([
            'field_name' => $field_name,
            'entity_type' => 'entity_test',
            'type' => 'float',
        ])->save();
        $field = FieldConfig::create([
            'field_name' => $field_name,
            'entity_type' => 'entity_test',
            'bundle' => 'entity_test',
        ]);
        $field->save();
        // Set the minimum value to a float value.
        $this->assertSetMinimumValue($field, 0.0001);
        // Set the minimum value to an integer value.
        $this->assertSetMinimumValue($field, 1);
    }
    
    /**
     * Tests setting the minimum value of a decimal field through the interface.
     */
    public function testCreateNumberDecimalField() {
        // Create a decimal field.
        $field_name = mb_strtolower($this->randomMachineName());
        FieldStorageConfig::create([
            'field_name' => $field_name,
            'entity_type' => 'entity_test',
            'type' => 'decimal',
        ])->save();
        $field = FieldConfig::create([
            'field_name' => $field_name,
            'entity_type' => 'entity_test',
            'bundle' => 'entity_test',
        ]);
        $field->save();
        // Set the minimum value to a decimal value.
        $this->assertSetMinimumValue($field, 0.1);
        // Set the minimum value to an integer value.
        $this->assertSetMinimumValue($field, 1);
    }
    
    /**
     * Helper function to set the minimum value of a field.
     */
    public function assertSetMinimumValue($field, $minimum_value) {
        $field_configuration_url = 'entity_test/structure/entity_test/fields/entity_test.entity_test.' . $field->getName();
        // Set the minimum value.
        $edit = [
            'settings[min]' => $minimum_value,
        ];
        $this->drupalPostForm($field_configuration_url, $edit, t('Save settings'));
        // Check if an error message is shown.
        $this->assertNoRaw(t('%name is not a valid number.', [
            '%name' => t('Minimum'),
        ]), 'Saved ' . gettype($minimum_value) . '  value as minimal value on a ' . $field->getType() . ' field');
        // Check if a success message is shown.
        $this->assertRaw(t('Saved %label configuration.', [
            '%label' => $field->getLabel(),
        ]));
        // Check if the minimum value was actually set.
        $this->drupalGet($field_configuration_url);
        $this->assertFieldById('edit-settings-min', $minimum_value, 'Minimal ' . gettype($minimum_value) . '  value was set on a ' . $field->getType() . ' field.');
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias Overriden Title Overrides
AssertHelperTrait::castSafeStrings protected static function Casts MarkupInterface objects into strings.
AssertLegacyTrait::assert protected function
AssertLegacyTrait::assertCacheTag protected function Asserts whether an expected cache tag was present in the last response.
AssertLegacyTrait::assertElementNotPresent protected function Asserts that the element with the given CSS selector is not present.
AssertLegacyTrait::assertElementPresent protected function Asserts that the element with the given CSS selector is present.
AssertLegacyTrait::assertEqual protected function
AssertLegacyTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertLegacyTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertLegacyTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertLegacyTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertLegacyTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertLegacyTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertLegacyTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertLegacyTrait::assertHeader protected function Checks that current response header equals value.
AssertLegacyTrait::assertIdentical protected function
AssertLegacyTrait::assertIdenticalObject protected function
AssertLegacyTrait::assertLink protected function Passes if a link with the specified label is found.
AssertLegacyTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertLegacyTrait::assertNoCacheTag protected function Asserts whether an expected cache tag was absent in the last response.
AssertLegacyTrait::assertNoEscaped protected function Passes if the raw text is not found escaped on the loaded page.
AssertLegacyTrait::assertNoField protected function Asserts that a field does NOT exist with the given name or ID.
AssertLegacyTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertLegacyTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertLegacyTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertLegacyTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertLegacyTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertLegacyTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertLegacyTrait::assertNoOption protected function Asserts that a select option does NOT exist in the current page.
AssertLegacyTrait::assertNoPattern protected function Triggers a pass if the Perl regex pattern is not found in the raw content.
AssertLegacyTrait::assertNoRaw protected function Passes if the raw text IS not found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertNotEqual protected function
AssertLegacyTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text. 1
AssertLegacyTrait::assertNotIdentical protected function
AssertLegacyTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertLegacyTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertLegacyTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertLegacyTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertLegacyTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertLegacyTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise. 1
AssertLegacyTrait::assertResponse protected function Asserts the page responds with the specified response code. 1
AssertLegacyTrait::assertText protected function Passes if the page (with HTML stripped) contains the text. 1
AssertLegacyTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertLegacyTrait::assertTitle protected function Pass if the page title is the given string.
AssertLegacyTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertLegacyTrait::assertUrl protected function Passes if the internal browser's URL matches the given path.
AssertLegacyTrait::buildXPathQuery protected function Builds an XPath query.
AssertLegacyTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertLegacyTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertLegacyTrait::getRawContent protected function Gets the current raw content.
AssertLegacyTrait::pass protected function
AssertLegacyTrait::verbose protected function
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 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::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 drupal_rewrite_settings().
BrowserTestBase::$databasePrefix protected property The database prefix of this test run.
BrowserTestBase::$mink protected property Mink session manager.
BrowserTestBase::$minkDefaultDriverArgs protected property
BrowserTestBase::$minkDefaultDriverClass protected property 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. 39
BrowserTestBase::$root protected property The app root.
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 Simpletest environment.
BrowserTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
BrowserTestBase::cssSelectToXpath protected function Translates a CSS expression to its XPath equivalent.
BrowserTestBase::drupalGetHeader protected function Gets the value of an HTTP response header.
BrowserTestBase::drupalGetHeaders Deprecated protected function Returns all response headers.
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 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::getOptions protected function Helper function to get the options of select field.
BrowserTestBase::getResponseLogHandler protected function Provides a Guzzle middleware handler to log every response received. Overrides BrowserHtmlDebugTrait::getResponseLogHandler
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 Simpletest site. 1
BrowserTestBase::registerSessions protected function Registers additional Mink sessions.
BrowserTestBase::tearDown protected function 3
BrowserTestBase::translatePostValues protected function Transforms a nested array into a flat array suitable for drupalPostForm().
BrowserTestBase::xpath protected function Performs an xpath search on the contents of the internal browser.
BrowserTestBase::__construct public function 1
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
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::$configDirectories Deprecated protected property The config directories used in this test.
FunctionalTestSetupTrait::$rootUser protected property The "#1" admin user.
FunctionalTestSetupTrait::doInstall protected function Execute the non-interactive installer. 1
FunctionalTestSetupTrait::getDatabaseTypes protected function Returns all supported database driver installer objects.
FunctionalTestSetupTrait::initConfig protected function Initialize various configurations post-installation. 2
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.
FunctionalTestSetupTrait::installModulesFromClassProperty protected function Install modules defined by `static::$modules`. 1
FunctionalTestSetupTrait::installParameters protected function Returns the parameters that will be used when Simpletest installs Drupal. 9
FunctionalTestSetupTrait::prepareEnvironment protected function Prepares the current environment for running the test. 23
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. 2
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.
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
NumberFieldTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
NumberFieldTest::$modules public static property Modules to enable. Overrides BrowserTestBase::$modules
NumberFieldTest::assertSetMinimumValue public function Helper function to set the minimum value of a field.
NumberFieldTest::setUp protected function Overrides BrowserTestBase::setUp
NumberFieldTest::testCreateNumberDecimalField public function Tests setting the minimum value of a decimal field through the interface.
NumberFieldTest::testCreateNumberFloatField public function Tests setting the minimum value of a float field through the interface.
NumberFieldTest::testNumberDecimalField public function Test decimal field.
NumberFieldTest::testNumberFloatField public function Test float field.
NumberFieldTest::testNumberIntegerField public function Test integer field.
PhpunitCompatibilityTrait::getMock Deprecated public function Returns a mock object for the specified class using the available method.
PhpunitCompatibilityTrait::setExpectedException Deprecated public function Compatibility layer for PHPUnit 6 to support PHPUnit 4 code.
RandomGeneratorTrait::$randomGenerator protected property The random generator.
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. 1
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 public function Callback for random string validation.
RefreshVariablesTrait::refreshVariables protected function Refreshes in-memory configuration and state information. 3
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 private function Checks missing module requirements.
TestRequirementsTrait::checkRequirements protected function Check module requirements for the Drupal use case. 1
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.
TestSetupTrait::$container protected property The dependency injection container used in the test.
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::$siteDirectory protected property The site directory of this test run.
TestSetupTrait::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 2
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 public static function Returns the database connection to the site running Simpletest.
TestSetupTrait::prepareDatabasePrefix protected function Generates a database prefix for running tests. 2
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::assertSession public function Returns WebAssert object. 1
UiHelperTrait::buildUrl protected function Builds an a 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::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::drupalPostForm protected function Executes a form submission.
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::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.