class ElementsTableSelectTest

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

Tests the tableselect form element for expected behavior.

@group Form @group #slow

Hierarchy

Expanded class hierarchy of ElementsTableSelectTest

File

core/modules/system/tests/src/Functional/Form/ElementsTableSelectTest.php, line 16

Namespace

Drupal\Tests\system\Functional\Form
View source
class ElementsTableSelectTest extends BrowserTestBase {
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'form_test',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'stark';
    
    /**
     * Tests the display of checkboxes when #multiple is TRUE.
     */
    public function testMultipleTrue() : void {
        $this->drupalGet('form_test/tableselect/multiple-true');
        $this->assertSession()
            ->responseNotContains('Empty text.');
        // Test for the presence of the Select all rows tableheader.
        $this->assertSession()
            ->elementExists('xpath', '//th[@class="select-all"]');
        $rows = [
            'row1',
            'row2',
            'row3',
        ];
        foreach ($rows as $row) {
            $this->assertSession()
                ->elementExists('xpath', '//input[@type="checkbox"]');
        }
    }
    
    /**
     * Tests the display of radios when #multiple is FALSE.
     */
    public function testMultipleFalse() : void {
        $this->drupalGet('form_test/tableselect/multiple-false');
        $this->assertSession()
            ->pageTextNotContains('Empty text.');
        // Test for the absence of the Select all rows tableheader.
        $this->assertSession()
            ->elementNotExists('xpath', '//th[@class="select-all"]');
        $rows = [
            'row1',
            'row2',
            'row3',
        ];
        foreach ($rows as $row) {
            $this->assertSession()
                ->elementExists('xpath', '//input[@type="radio"]');
        }
    }
    
    /**
     * Tests the display when #colspan is set.
     */
    public function testTableSelectColSpan() : void {
        $this->drupalGet('form_test/tableselect/colspan');
        // Verify presence of column three and absence of column four.
        $this->assertSession()
            ->pageTextContains('Three');
        $this->assertSession()
            ->pageTextNotContains('Four');
        // There should be three labeled column headers and 1 for the input.
        $this->assertSession()
            ->elementsCount('xpath', '//thead/tr/th', 4);
        // The first two body rows should each have 5 table cells: One for the
        // radio, one cell in the first column, one cell in the second column,
        // and two cells in the third column which has colspan 2.
        for ($i = 0; $i <= 1; $i++) {
            $this->assertSession()
                ->elementsCount('xpath', '//tbody/tr[' . ($i + 1) . ']/td', 5);
        }
        // The third row should have 3 cells, one for the radio, one spanning the
        // first and second column, and a third in column 3 (which has colspan 3).
        $this->assertSession()
            ->elementsCount('xpath', '//tbody/tr[3]/td', 3);
    }
    
    /**
     * Tests the display of the #empty text when #options is an empty array.
     */
    public function testEmptyText() : void {
        $this->drupalGet('form_test/tableselect/empty-text');
        $this->assertSession()
            ->pageTextContains('Empty text.');
    }
    
    /**
     * Tests the submission of single and multiple values when #multiple is TRUE.
     */
    public function testMultipleTrueSubmit() : void {
        // Test a submission with one checkbox checked.
        $edit = [];
        $edit['tableselect[row1]'] = TRUE;
        $this->drupalGet('form_test/tableselect/multiple-true');
        $this->submitForm($edit, 'Submit');
        $assert_session = $this->assertSession();
        $assert_session->pageTextContains('Submitted: row1 = row1');
        $assert_session->pageTextContains('Submitted: row2 = 0');
        $assert_session->pageTextContains('Submitted: row3 = 0');
        // Test a submission with multiple checkboxes checked.
        $edit['tableselect[row1]'] = TRUE;
        $edit['tableselect[row3]'] = TRUE;
        $this->drupalGet('form_test/tableselect/multiple-true');
        $this->submitForm($edit, 'Submit');
        $assert_session->pageTextContains('Submitted: row1 = row1');
        $assert_session->pageTextContains('Submitted: row2 = 0');
        $assert_session->pageTextContains('Submitted: row3 = row3');
    }
    
    /**
     * Tests submission of values when #multiple is FALSE.
     */
    public function testMultipleFalseSubmit() : void {
        $edit['tableselect'] = 'row1';
        $this->drupalGet('form_test/tableselect/multiple-false');
        $this->submitForm($edit, 'Submit');
        $this->assertSession()
            ->pageTextContains('Submitted: row1');
    }
    
    /**
     * Tests the #js_select property.
     */
    public function testAdvancedSelect() : void {
        // When #multiple = TRUE a Select all checkbox should be displayed by default.
        $this->drupalGet('form_test/tableselect/advanced-select/multiple-true-default');
        $this->assertSession()
            ->elementExists('xpath', '//th[@class="select-all"]');
        // When #js_select is set to FALSE, a "Select all" checkbox should not be displayed.
        $this->drupalGet('form_test/tableselect/advanced-select/multiple-true-no-advanced-select');
        $this->assertSession()
            ->elementNotExists('xpath', '//th[@class="select-all"]');
        // A "Select all" checkbox never makes sense when #multiple = FALSE, regardless of the value of #js_select.
        $this->drupalGet('form_test/tableselect/advanced-select/multiple-false-default');
        $this->assertSession()
            ->elementNotExists('xpath', '//th[@class="select-all"]');
        $this->drupalGet('form_test/tableselect/advanced-select/multiple-false-advanced-select');
        $this->assertSession()
            ->elementNotExists('xpath', '//th[@class="select-all"]');
    }
    
    /**
     * Tests error handling for invalid tableselect values with checkboxes.
     */
    public function testMultipleTrueOptionChecker() : void {
        [
            $header,
            $options,
        ] = _form_test_tableselect_get_data();
        $form['tableselect'] = [
            '#type' => 'tableselect',
            '#header' => $header,
            '#options' => $options,
        ];
        // Test with a valid value.
        [
            ,
            ,
            $errors,
        ] = $this->formSubmitHelper($form, [
            'tableselect' => [
                'row1' => 'row1',
            ],
        ]);
        $this->assertFalse(isset($errors['tableselect']), 'Option checker allows valid values for checkboxes.');
        // Test with an invalid value.
        [
            ,
            ,
            $errors,
        ] = $this->formSubmitHelper($form, [
            'tableselect' => [
                'non_existing_value' => 'non_existing_value',
            ],
        ]);
        $this->assertTrue(isset($errors['tableselect']), 'Option checker disallows invalid values for checkboxes.');
    }
    
    /**
     * Tests error handling for invalid tableselect values with radio buttons.
     */
    public function testMultipleFalseOptionChecker() : void {
        [
            $header,
            $options,
        ] = _form_test_tableselect_get_data();
        $form['tableselect'] = [
            '#type' => 'tableselect',
            '#header' => $header,
            '#options' => $options,
            '#multiple' => FALSE,
        ];
        // Test with a valid value.
        [
            ,
            ,
            $errors,
        ] = $this->formSubmitHelper($form, [
            'tableselect' => 'row1',
        ]);
        $this->assertFalse(isset($errors['tableselect']), 'Option checker allows valid values for radio buttons.');
        // Test with an invalid value.
        [
            ,
            ,
            $errors,
        ] = $this->formSubmitHelper($form, [
            'tableselect' => 'non_existing_value',
        ]);
        $this->assertTrue(isset($errors['tableselect']), 'Option checker disallows invalid values for radio buttons.');
    }
    
    /**
     * Helper function for the option check test to submit a form while collecting errors.
     *
     * @param array $form
     *   Nested array of form elements that comprise the form.
     * @param array $edit
     *   An array containing post data.
     *
     * @return array
     *   An array containing the processed form, the form_state and any errors.
     *
     * @internal param $form_element A form element to test.
     *   A form element to test.
     */
    private function formSubmitHelper($form, $edit) {
        $form_id = $this->randomMachineName();
        $form_state = new FormState();
        $form['op'] = [
            '#type' => 'submit',
            '#value' => 'Submit',
        ];
        // The form token CSRF protection should not interfere with this test, so we
        // bypass it by setting the token to FALSE.
        $form['#token'] = FALSE;
        $edit['form_id'] = $form_id;
        // Disable page redirect for forms submitted programmatically. This is a
        // solution to skip the redirect step (there are no pages, then the redirect
        // isn't possible).
        $form_state->disableRedirect();
        $form_state->setUserInput($edit);
        $form_state->setFormObject(new StubForm($form_id, $form));
        \Drupal::formBuilder()->prepareForm($form_id, $form, $form_state);
        \Drupal::formBuilder()->processForm($form_id, $form, $form_state);
        $errors = $form_state->getErrors();
        // Clear errors and messages.
        \Drupal::messenger()->deleteAll();
        $form_state->clearErrors();
        // Return the processed form together with form_state and errors
        // to allow the caller low-level access to the form.
        return [
            $form,
            $form_state,
            $errors,
        ];
    }

}

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::setUp protected function 544
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
ElementsTableSelectTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
ElementsTableSelectTest::$modules protected static property Modules to install. Overrides BrowserTestBase::$modules
ElementsTableSelectTest::formSubmitHelper private function Helper function for the option check test to submit a form while collecting errors.
ElementsTableSelectTest::testAdvancedSelect public function Tests the #js_select property.
ElementsTableSelectTest::testEmptyText public function Tests the display of the #empty text when #options is an empty array.
ElementsTableSelectTest::testMultipleFalse public function Tests the display of radios when #multiple is FALSE.
ElementsTableSelectTest::testMultipleFalseOptionChecker public function Tests error handling for invalid tableselect values with radio buttons.
ElementsTableSelectTest::testMultipleFalseSubmit public function Tests submission of values when #multiple is FALSE.
ElementsTableSelectTest::testMultipleTrue public function Tests the display of checkboxes when #multiple is TRUE.
ElementsTableSelectTest::testMultipleTrueOptionChecker public function Tests error handling for invalid tableselect values with checkboxes.
ElementsTableSelectTest::testMultipleTrueSubmit public function Tests the submission of single and multiple values when #multiple is TRUE.
ElementsTableSelectTest::testTableSelectColSpan public function Tests the display when #colspan is set.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FunctionalTestSetupTrait::$apcuEnsureUniquePrefix protected property The flag to set &#039;apcu_ensure_unique_prefix&#039; setting. 1
FunctionalTestSetupTrait::$classLoader protected property The class loader to use for installation and initialization of setup.
FunctionalTestSetupTrait::$rootUser protected property The &quot;#1&quot; 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
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.