class FilterDateTest

Same name in this branch
  1. 10 core/modules/datetime_range/tests/src/Kernel/Views/FilterDateTest.php \Drupal\Tests\datetime_range\Kernel\Views\FilterDateTest
  2. 10 core/modules/datetime/tests/src/Kernel/Views/FilterDateTest.php \Drupal\Tests\datetime\Kernel\Views\FilterDateTest
  3. 10 core/modules/datetime/tests/src/Functional/Views/FilterDateTest.php \Drupal\Tests\datetime\Functional\Views\FilterDateTest
Same name in other branches
  1. 9 core/modules/views/tests/src/Functional/Handler/FilterDateTest.php \Drupal\Tests\views\Functional\Handler\FilterDateTest
  2. 9 core/modules/datetime_range/tests/src/Kernel/Views/FilterDateTest.php \Drupal\Tests\datetime_range\Kernel\Views\FilterDateTest
  3. 9 core/modules/datetime/tests/src/Kernel/Views/FilterDateTest.php \Drupal\Tests\datetime\Kernel\Views\FilterDateTest
  4. 9 core/modules/datetime/tests/src/Functional/Views/FilterDateTest.php \Drupal\Tests\datetime\Functional\Views\FilterDateTest
  5. 8.9.x core/modules/views/tests/src/Functional/Handler/FilterDateTest.php \Drupal\Tests\views\Functional\Handler\FilterDateTest
  6. 8.9.x core/modules/datetime_range/tests/src/Kernel/Views/FilterDateTest.php \Drupal\Tests\datetime_range\Kernel\Views\FilterDateTest
  7. 8.9.x core/modules/datetime/tests/src/Kernel/Views/FilterDateTest.php \Drupal\Tests\datetime\Kernel\Views\FilterDateTest
  8. 8.9.x core/modules/datetime/tests/src/Functional/Views/FilterDateTest.php \Drupal\Tests\datetime\Functional\Views\FilterDateTest
  9. 11.x core/modules/views/tests/src/Functional/Handler/FilterDateTest.php \Drupal\Tests\views\Functional\Handler\FilterDateTest
  10. 11.x core/modules/datetime_range/tests/src/Kernel/Views/FilterDateTest.php \Drupal\Tests\datetime_range\Kernel\Views\FilterDateTest
  11. 11.x core/modules/datetime/tests/src/Kernel/Views/FilterDateTest.php \Drupal\Tests\datetime\Kernel\Views\FilterDateTest
  12. 11.x core/modules/datetime/tests/src/Functional/Views/FilterDateTest.php \Drupal\Tests\datetime\Functional\Views\FilterDateTest

Tests the core Drupal\views\Plugin\views\filter\Date handler.

@group views

Hierarchy

Expanded class hierarchy of FilterDateTest

File

core/modules/views/tests/src/Functional/Handler/FilterDateTest.php, line 19

Namespace

Drupal\Tests\views\Functional\Handler
View source 
class FilterDateTest extends ViewTestBase {
    use SchemaCheckTestTrait;
    
    /**
     * Views used by this test.
     *
     * @var array
     */
    public static $testViews = [
        'test_filter_date_between',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'node',
        'views_ui',
        'datetime',
    ];
    
    /**
     * {@inheritdoc}
     */
    protected $defaultTheme = 'starterkit_theme';
    
    /**
     * The date formatter.
     *
     * @var \Drupal\Core\Datetime\DateFormatterInterface
     */
    public $dateFormatter;
    
    /**
     * @var array
     */
    protected array $nodes;
    
    /**
     * @var array
     */
    protected array $map;
    
    /**
     * {@inheritdoc}
     */
    protected function setUp($import_test_views = TRUE, $modules = [
        'views_test_config',
    ]) : void {
        parent::setUp($import_test_views, $modules);
        $this->dateFormatter = $this->container
            ->get('date.formatter');
        // Add a date field so we can test datetime handling.
        NodeType::create([
            'type' => 'page',
            'name' => 'Page',
        ])->save();
        // Setup a field storage and field, but also change the views data for the
        // entity_test entity type.
        $field_storage = FieldStorageConfig::create([
            'field_name' => 'field_date',
            'type' => 'datetime',
            'entity_type' => 'node',
        ]);
        $field_storage->save();
        $field = FieldConfig::create([
            'field_name' => 'field_date',
            'entity_type' => 'node',
            'bundle' => 'page',
        ]);
        $field->save();
        // Add some basic test nodes.
        $this->nodes = [];
        $this->nodes[] = $this->drupalCreateNode([
            'created' => 100000,
            'field_date' => 10000,
        ]);
        $this->nodes[] = $this->drupalCreateNode([
            'created' => 200000,
            'field_date' => 20000,
        ]);
        $this->nodes[] = $this->drupalCreateNode([
            'created' => 300000,
            'field_date' => 30000,
        ]);
        $this->nodes[] = $this->drupalCreateNode([
            'created' => time() + 86400,
            'field_date' => time() + 86400,
        ]);
        $this->map = [
            'nid' => 'nid',
        ];
    }
    
    /**
     * Runs other test methods.
     */
    public function testDateFilter() : void {
        $this->_testOffset();
        $this->_testBetween();
        $this->_testUiValidation();
        $this->_testFilterDateUI();
        $this->_testFilterDatetimeUI();
    }
    
    /**
     * Tests the general offset functionality.
     */
    protected function _testOffset() {
        $view = Views::getView('test_filter_date_between');
        // Test offset for simple operator.
        $view->initHandlers();
        $view->filter['created']->operator = '>';
        $view->filter['created']->value['type'] = 'offset';
        $view->filter['created']->value['value'] = '+1 hour';
        $view->executeDisplay('default');
        $expected_result = [
            [
                'nid' => $this->nodes[3]
                    ->id(),
            ],
        ];
        $this->assertIdenticalResultset($view, $expected_result, $this->map);
        $view->destroy();
        // Test offset for between operator.
        $view->initHandlers();
        $view->filter['created']->operator = 'between';
        $view->filter['created']->value['type'] = 'offset';
        $view->filter['created']->value['max'] = '+2 days';
        $view->filter['created']->value['min'] = '+1 hour';
        $view->executeDisplay('default');
        $expected_result = [
            [
                'nid' => $this->nodes[3]
                    ->id(),
            ],
        ];
        $this->assertIdenticalResultset($view, $expected_result, $this->map);
    }
    
    /**
     * Tests the filter operator between/not between.
     */
    protected function _testBetween() {
        $view = Views::getView('test_filter_date_between');
        // Test between with min and max.
        $view->initHandlers();
        $view->filter['created']->operator = 'between';
        $view->filter['created']->value['min'] = $this->dateFormatter
            ->format(150000, 'custom', 'Y-m-d H:i:s');
        $view->filter['created']->value['max'] = $this->dateFormatter
            ->format(200000, 'custom', 'Y-m-d H:i:s');
        $view->executeDisplay('default');
        $expected_result = [
            [
                'nid' => $this->nodes[1]
                    ->id(),
            ],
        ];
        $this->assertIdenticalResultset($view, $expected_result, $this->map);
        $view->destroy();
        // Test between with just max.
        $view->initHandlers();
        $view->filter['created']->operator = 'between';
        $view->filter['created']->value['max'] = $this->dateFormatter
            ->format(200000, 'custom', 'Y-m-d H:i:s');
        $view->executeDisplay('default');
        $expected_result = [
            [
                'nid' => $this->nodes[0]
                    ->id(),
            ],
            [
                'nid' => $this->nodes[1]
                    ->id(),
            ],
        ];
        $this->assertIdenticalResultset($view, $expected_result, $this->map);
        $view->destroy();
        // Test not between with min and max.
        $view->initHandlers();
        $view->filter['created']->operator = 'not between';
        $view->filter['created']->value['min'] = $this->dateFormatter
            ->format(100000, 'custom', 'Y-m-d H:i:s');
        $view->filter['created']->value['max'] = $this->dateFormatter
            ->format(200000, 'custom', 'Y-m-d H:i:s');
        $view->executeDisplay('default');
        $expected_result = [
            [
                'nid' => $this->nodes[2]
                    ->id(),
            ],
            [
                'nid' => $this->nodes[3]
                    ->id(),
            ],
        ];
        $this->assertIdenticalResultset($view, $expected_result, $this->map);
        $view->destroy();
        // Test not between with just max.
        $view->initHandlers();
        $view->filter['created']->operator = 'not between';
        $view->filter['created']->value['max'] = $this->dateFormatter
            ->format(200000, 'custom', 'Y-m-d H:i:s');
        $view->executeDisplay('default');
        $expected_result = [
            [
                'nid' => $this->nodes[2]
                    ->id(),
            ],
            [
                'nid' => $this->nodes[3]
                    ->id(),
            ],
        ];
        $this->assertIdenticalResultset($view, $expected_result, $this->map);
    }
    
    /**
     * Make sure the validation callbacks works.
     */
    protected function _testUiValidation() {
        $this->drupalLogin($this->drupalCreateUser([
            'administer views',
            'administer site configuration',
        ]));
        $this->drupalGet('admin/structure/views/view/test_filter_date_between/edit');
        $this->drupalGet('admin/structure/views/nojs/handler/test_filter_date_between/default/filter/created');
        $edit = [];
        // Generate a definitive wrong value, which should be checked by validation.
        $edit['options[value][value]'] = $this->randomString() . '-------';
        $this->submitForm($edit, 'Apply');
        $this->assertSession()
            ->pageTextContains('Invalid date format.');
    }
    
    /**
     * Tests date filter UI.
     */
    protected function _testFilterDateUI() {
        $this->drupalLogin($this->drupalCreateUser([
            'administer views',
        ]));
        $this->drupalGet('admin/structure/views/nojs/handler/test_filter_date_between/default/filter/created');
        $this->submitForm([], 'Expose filter');
        $this->submitForm([], 'Grouped filters');
        $edit = [];
        $edit['options[group_info][group_items][1][title]'] = 'simple-offset';
        $edit['options[group_info][group_items][1][operator]'] = '>';
        $edit['options[group_info][group_items][1][value][type]'] = 'offset';
        $edit['options[group_info][group_items][1][value][value]'] = '+1 hour';
        $edit['options[group_info][group_items][2][title]'] = 'between-offset';
        $edit['options[group_info][group_items][2][operator]'] = 'between';
        $edit['options[group_info][group_items][2][value][type]'] = 'offset';
        $edit['options[group_info][group_items][2][value][min]'] = '+1 hour';
        $edit['options[group_info][group_items][2][value][max]'] = '+2 days';
        $edit['options[group_info][group_items][3][title]'] = 'between-date';
        $edit['options[group_info][group_items][3][operator]'] = 'between';
        $edit['options[group_info][group_items][3][value][min]'] = $this->dateFormatter
            ->format(150000, 'custom', 'Y-m-d H:i:s');
        $edit['options[group_info][group_items][3][value][max]'] = $this->dateFormatter
            ->format(250000, 'custom', 'Y-m-d H:i:s');
        $this->submitForm($edit, 'Apply');
        $this->drupalGet('admin/structure/views/nojs/handler/test_filter_date_between/default/filter/created');
        foreach ($edit as $name => $value) {
            $this->assertSession()
                ->fieldValueEquals($name, $value);
            if (strpos($name, '[value][type]')) {
                $radio = $this->cssSelect('input[name="' . $name . '"][checked="checked"][type="radio"]');
                $this->assertEquals($value, $radio[0]->getAttribute('value'));
            }
        }
        $this->drupalGet('admin/structure/views/view/test_filter_date_between');
        $this->submitForm([], 'Save');
        $this->assertConfigSchemaByName('views.view.test_filter_date_between');
        // Test that the exposed filter works as expected.
        $path = 'test_filter_date_between-path';
        $this->drupalGet('admin/structure/views/view/test_filter_date_between/edit');
        $this->submitForm([], 'Add Page');
        $this->drupalGet('admin/structure/views/nojs/display/test_filter_date_between/page_1/path');
        $this->submitForm([
            'path' => $path,
        ], 'Apply');
        $this->submitForm([], 'Save');
        $this->drupalGet($path);
        $this->submitForm([], 'Apply');
        $results = $this->cssSelect('.view-content .field-content');
        $this->assertCount(4, $results);
        $this->submitForm([
            'created' => '1',
        ], 'Apply');
        $results = $this->cssSelect('.view-content .field-content');
        $this->assertCount(1, $results);
        $this->assertEquals($this->nodes[3]
            ->id(), $results[0]->getText());
        $this->submitForm([
            'created' => '2',
        ], 'Apply');
        $results = $this->cssSelect('.view-content .field-content');
        $this->assertCount(1, $results);
        $this->assertEquals($this->nodes[3]
            ->id(), $results[0]->getText());
        $this->submitForm([
            'created' => '3',
        ], 'Apply');
        $results = $this->cssSelect('.view-content .field-content');
        $this->assertCount(1, $results);
        $this->assertEquals($this->nodes[1]
            ->id(), $results[0]->getText());
        // Change the filter to a single filter to test the schema when the operator
        // is not exposed.
        $this->drupalGet('admin/structure/views/nojs/handler/test_filter_date_between/default/filter/created');
        $this->submitForm([], 'Single filter');
        $edit = [];
        $edit['options[operator]'] = '>';
        $edit['options[value][type]'] = 'date';
        $edit['options[value][value]'] = $this->dateFormatter
            ->format(350000, 'custom', 'Y-m-d H:i:s');
        $this->submitForm($edit, 'Apply');
        $this->drupalGet('admin/structure/views/view/test_filter_date_between');
        $this->submitForm([], 'Save');
        $this->assertConfigSchemaByName('views.view.test_filter_date_between');
        // Test that the filter works as expected.
        $this->drupalGet($path);
        $results = $this->cssSelect('.view-content .field-content');
        $this->assertCount(1, $results);
        $this->assertEquals($this->nodes[3]
            ->id(), $results[0]->getText());
        $this->submitForm([
            'created' => $this->dateFormatter
                ->format(250000, 'custom', 'Y-m-d H:i:s'),
        ], 'Apply');
        $results = $this->cssSelect('.view-content .field-content');
        $this->assertCount(2, $results);
        $this->assertEquals($this->nodes[2]
            ->id(), $results[0]->getText());
        $this->assertEquals($this->nodes[3]
            ->id(), $results[1]->getText());
    }
    
    /**
     * Tests datetime grouped filter UI.
     */
    protected function _testFilterDatetimeUI() {
        $this->drupalLogin($this->drupalCreateUser([
            'administer views',
        ]));
        $this->drupalGet('admin/structure/views/nojs/add-handler/test_filter_date_between/default/filter');
        $this->submitForm([
            'name[node__field_date.field_date_value]' => 'node__field_date.field_date_value',
        ], 'Add and configure filter criteria');
        $this->submitForm([], 'Expose filter');
        $this->submitForm([], 'Grouped filters');
        $edit = [];
        $edit['options[group_info][group_items][1][title]'] = 'simple-offset';
        $edit['options[group_info][group_items][1][operator]'] = '>';
        $edit['options[group_info][group_items][1][value][type]'] = 'offset';
        $edit['options[group_info][group_items][1][value][value]'] = '+1 hour';
        $edit['options[group_info][group_items][2][title]'] = 'between-offset';
        $edit['options[group_info][group_items][2][operator]'] = 'between';
        $edit['options[group_info][group_items][2][value][type]'] = 'offset';
        $edit['options[group_info][group_items][2][value][min]'] = '+1 hour';
        $edit['options[group_info][group_items][2][value][max]'] = '+2 days';
        $edit['options[group_info][group_items][3][title]'] = 'between-date';
        $edit['options[group_info][group_items][3][operator]'] = 'between';
        $edit['options[group_info][group_items][3][value][min]'] = $this->dateFormatter
            ->format(150000, 'custom', 'Y-m-d H:i:s');
        $edit['options[group_info][group_items][3][value][max]'] = $this->dateFormatter
            ->format(250000, 'custom', 'Y-m-d H:i:s');
        $this->submitForm($edit, 'Apply');
        $this->drupalGet('admin/structure/views/view/test_filter_date_between');
        $this->submitForm([], 'Save');
        $this->assertConfigSchemaByName('views.view.test_filter_date_between');
    }
    
    /**
     * Tests that the exposed date filter is displayed without errors.
     */
    public function testExposedFilter() : void {
        $this->drupalLogin($this->drupalCreateUser([
            'administer views',
        ]));
        $this->drupalGet('admin/structure/views/nojs/handler/test_filter_date_between/default/filter/created');
        $this->submitForm([], 'Expose filter');
        $this->drupalGet('admin/structure/views/view/test_filter_date_between/edit');
        $this->submitForm([], 'Add Page');
        $edit = [
            'path' => 'exposed-date-filter',
        ];
        $this->drupalGet('admin/structure/views/nojs/display/test_filter_date_between/page_1/path');
        $this->submitForm($edit, 'Apply');
        $this->submitForm([], 'Save');
        $this->drupalGet('exposed-date-filter');
        $this->assertSession()
            ->fieldExists('created');
    }

}

Members

Title 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.
FilterDateTest::$dateFormatter public property The date formatter.
FilterDateTest::$defaultTheme protected property The theme to install as the default for testing. Overrides BrowserTestBase::$defaultTheme
FilterDateTest::$map protected property
FilterDateTest::$modules protected static property Modules to install. Overrides ViewTestBase::$modules
FilterDateTest::$nodes protected property
FilterDateTest::$testViews public static property Views used by this test.
FilterDateTest::setUp protected function Sets up the test. Overrides ViewTestBase::setUp
FilterDateTest::testDateFilter public function Runs other test methods.
FilterDateTest::testExposedFilter public function Tests that the exposed date filter is displayed without errors.
FilterDateTest::_testBetween protected function Tests the filter operator between/not between.
FilterDateTest::_testFilterDatetimeUI protected function Tests datetime grouped filter UI.
FilterDateTest::_testFilterDateUI protected function Tests date filter UI.
FilterDateTest::_testOffset protected function Tests the general offset functionality.
FilterDateTest::_testUiValidation protected function Make sure the validation callbacks works.
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
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
SchemaCheckTestTrait::assertConfigSchema public function Asserts the TypedConfigManager has a valid schema for the configuration.
SchemaCheckTestTrait::assertConfigSchemaByName public function Asserts configuration, specified by name, has a valid schema.
SchemaCheckTrait::$configName protected property The configuration object name under test.
SchemaCheckTrait::$ignoredPropertyPaths protected static property The ignored property paths.
SchemaCheckTrait::$schema protected property The config schema wrapper object for the configuration object under test.
SchemaCheckTrait::checkConfigSchema public function Checks the TypedConfigManager has a valid schema for the configuration.
SchemaCheckTrait::checkValue protected function Helper method to check data type.
SchemaCheckTrait::isViolationForIgnoredPropertyPath protected static function Determines whether this violation is for an ignored Config property path.
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.
ViewResultAssertionTrait::assertIdenticalResultset protected function Verifies that a result set returned by a View matches expected values.
ViewResultAssertionTrait::assertIdenticalResultsetHelper protected function Performs View result assertions.
ViewResultAssertionTrait::assertNotIdenticalResultset protected function Verifies that a result set returned by a View differs from certain values.
ViewTestBase::dataSet protected function Returns a very simple test dataset. 1
ViewTestBase::enableViewsTestModule protected function Sets up the views_test_data.module.
ViewTestBase::executeView protected function Executes a view.
ViewTestBase::helperButtonHasLabel protected function Asserts the existence of a button with a certain ID and label.
ViewTestBase::orderResultSet protected function Orders a nested array containing a result set based on a given column.
ViewTestBase::schemaDefinition protected function Returns the schema definition. 1
ViewTestBase::viewsData protected function Returns the views data definition. 8
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.