class FilterDateTest

Same name in this branch
  1. 10 core/modules/views/tests/src/Functional/Handler/FilterDateTest.php \Drupal\Tests\views\Functional\Handler\FilterDateTest
  2. 10 core/modules/datetime_range/tests/src/Kernel/Views/FilterDateTest.php \Drupal\Tests\datetime_range\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 date-only fields.

@group datetime

Hierarchy

Expanded class hierarchy of FilterDateTest

File

core/modules/datetime/tests/src/Kernel/Views/FilterDateTest.php, line 17

Namespace

Drupal\Tests\datetime\Kernel\Views
View source
class FilterDateTest extends DateTimeHandlerTestBase {
    
    /**
     * {@inheritdoc}
     */
    public static $testViews = [
        'test_filter_datetime',
    ];
    
    /**
     * An array of timezone extremes to test.
     *
     * @var string[]
     */
    protected static $timezones = [
        // UTC-12, no DST.
'Pacific/Kwajalein',
        // UTC-11, no DST.
'Pacific/Midway',
        // UTC-7, no DST.
'America/Phoenix',
        // UTC.
'UTC',
        // UTC+5:30, no DST.
'Asia/Kolkata',
        // UTC+12, no DST.
'Pacific/Funafuti',
        // UTC+13, no DST.
'Pacific/Tongatapu',
    ];
    
    /**
     * {@inheritdoc}
     *
     * Create nodes with relative dates of yesterday, today, and tomorrow.
     */
    protected function setUp($import_test_views = TRUE) : void {
        parent::setUp($import_test_views);
        // Change field storage to date-only.
        $storage = FieldStorageConfig::load('node.' . static::$fieldName);
        $storage->setSetting('datetime_type', DateTimeItem::DATETIME_TYPE_DATE);
        $storage->save();
        // Retrieve tomorrow, today and yesterday dates just to create the nodes.
        $timestamp = $this->getUTCEquivalentOfUserNowAsTimestamp();
        $dates = $this->getRelativeDateValuesFromTimestamp($timestamp);
        // Clean the nodes on setUp.
        $this->nodes = [];
        foreach ($dates as $date) {
            $node = Node::create([
                'title' => $this->randomMachineName(8),
                'type' => 'page',
                'field_date' => [
                    'value' => $date,
                ],
            ]);
            $node->save();
            $this->nodes[] = $node;
        }
        // Add a node where the date field is empty.
        $node = Node::create([
            'title' => $this->randomMachineName(8),
            'type' => 'page',
            'field_date' => [],
        ]);
        $node->save();
        $this->nodes[] = $node;
    }
    
    /**
     * Tests offsets with date-only fields.
     */
    public function testDateOffsets() : void {
        $view = Views::getView('test_filter_datetime');
        $field = static::$fieldName . '_value';
        foreach (static::$timezones as $timezone) {
            $this->setSiteTimezone($timezone);
            $timestamp = $this->getUTCEquivalentOfUserNowAsTimestamp();
            $dates = $this->getRelativeDateValuesFromTimestamp($timestamp);
            $this->updateNodesDateFieldsValues($dates);
            // Test simple operations.
            $view->initHandlers();
            // A greater than or equal to 'now', should return the 'today' and the
            // 'tomorrow' node.
            $view->filter[$field]->operator = '>=';
            $view->filter[$field]->value['type'] = 'offset';
            $view->filter[$field]->value['value'] = 'now';
            $view->setDisplay('default');
            $this->executeView($view);
            $expected_result = [
                [
                    'nid' => $this->nodes[0]
                        ->id(),
                ],
                [
                    'nid' => $this->nodes[1]
                        ->id(),
                ],
            ];
            $this->assertIdenticalResultset($view, $expected_result, $this->map);
            $view->destroy();
            // Only dates in the past.
            $view->initHandlers();
            $view->filter[$field]->operator = '<';
            $view->filter[$field]->value['type'] = 'offset';
            $view->filter[$field]->value['value'] = 'now';
            $view->setDisplay('default');
            $this->executeView($view);
            $expected_result = [
                [
                    'nid' => $this->nodes[2]
                        ->id(),
                ],
            ];
            $this->assertIdenticalResultset($view, $expected_result, $this->map);
            $view->destroy();
            // Test offset for between operator. Only 'tomorrow' node should appear.
            $view->initHandlers();
            $view->filter[$field]->operator = 'between';
            $view->filter[$field]->value['type'] = 'offset';
            $view->filter[$field]->value['max'] = '+2 days';
            $view->filter[$field]->value['min'] = '+1 day';
            $view->setDisplay('default');
            $this->executeView($view);
            $expected_result = [
                [
                    'nid' => $this->nodes[0]
                        ->id(),
                ],
            ];
            $this->assertIdenticalResultset($view, $expected_result, $this->map);
            $view->destroy();
            // Test the empty operator.
            $view->initHandlers();
            $view->filter[$field]->operator = 'empty';
            $view->setDisplay('default');
            $this->executeView($view);
            $expected_result = [
                [
                    'nid' => $this->nodes[3]
                        ->id(),
                ],
            ];
            $this->assertIdenticalResultset($view, $expected_result, $this->map);
            $view->destroy();
            // Test the not empty operator.
            $view->initHandlers();
            $view->filter[$field]->operator = 'not empty';
            $view->setDisplay('default');
            $this->executeView($view);
            $expected_result = [
                [
                    'nid' => $this->nodes[0]
                        ->id(),
                ],
                [
                    'nid' => $this->nodes[1]
                        ->id(),
                ],
                [
                    'nid' => $this->nodes[2]
                        ->id(),
                ],
            ];
            $this->assertIdenticalResultset($view, $expected_result, $this->map);
            $view->destroy();
        }
    }
    
    /**
     * Tests date filter with date-only fields.
     */
    public function testDateIs() : void {
        $view = Views::getView('test_filter_datetime');
        $field = static::$fieldName . '_value';
        foreach (static::$timezones as $timezone) {
            $this->setSiteTimezone($timezone);
            $timestamp = $this->getUTCEquivalentOfUserNowAsTimestamp();
            $dates = $this->getRelativeDateValuesFromTimestamp($timestamp);
            $this->updateNodesDateFieldsValues($dates);
            // Test simple operations.
            $view->initHandlers();
            // Filtering with nodes date-only values (format: Y-m-d) to test UTC
            // conversion does NOT change the day.
            $view->filter[$field]->operator = '=';
            $view->filter[$field]->value['type'] = 'date';
            $view->filter[$field]->value['value'] = $this->nodes[2]->field_date
                ->first()
                ->getValue()['value'];
            $view->setDisplay('default');
            $this->executeView($view);
            $expected_result = [
                [
                    'nid' => $this->nodes[2]
                        ->id(),
                ],
            ];
            $this->assertIdenticalResultset($view, $expected_result, $this->map);
            $view->destroy();
            // Test offset for between operator. Only 'today' and 'tomorrow' nodes
            // should appear.
            $view->initHandlers();
            $view->filter[$field]->operator = 'between';
            $view->filter[$field]->value['type'] = 'date';
            $view->filter[$field]->value['max'] = $this->nodes[0]->field_date
                ->first()
                ->getValue()['value'];
            $view->filter[$field]->value['min'] = $this->nodes[1]->field_date
                ->first()
                ->getValue()['value'];
            $view->setDisplay('default');
            $this->executeView($view);
            $expected_result = [
                [
                    'nid' => $this->nodes[0]
                        ->id(),
                ],
                [
                    'nid' => $this->nodes[1]
                        ->id(),
                ],
            ];
            $this->assertIdenticalResultset($view, $expected_result, $this->map);
            $view->destroy();
        }
    }
    
    /**
     * Updates tests nodes date fields values.
     *
     * @param array $dates
     *   An array of DATETIME_DATE_STORAGE_FORMAT date values.
     */
    protected function updateNodesDateFieldsValues(array $dates) {
        foreach ($dates as $index => $date) {
            $this->nodes[$index]->{static::$fieldName}->value = $date;
            $this->nodes[$index]
                ->save();
        }
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
AssertContentTrait::$content protected property The current raw content.
AssertContentTrait::$drupalSettings protected property The drupalSettings value from the current raw $content.
AssertContentTrait::$elements protected property The XML structure parsed from the current raw $content. 1
AssertContentTrait::$plainTextContent protected property The plain-text content of raw $content (text nodes).
AssertContentTrait::assertEscaped protected function Passes if the raw text IS found escaped on the loaded page, fail otherwise.
AssertContentTrait::assertField protected function Asserts that a field exists with the given name or ID.
AssertContentTrait::assertFieldById protected function Asserts that a field exists with the given ID and value.
AssertContentTrait::assertFieldByName protected function Asserts that a field exists with the given name and value.
AssertContentTrait::assertFieldByXPath protected function Asserts that a field exists in the current page by the given XPath.
AssertContentTrait::assertFieldChecked protected function Asserts that a checkbox field in the current page is checked.
AssertContentTrait::assertFieldsByValue protected function Asserts that a field exists in the current page with a given Xpath result.
AssertContentTrait::assertLink protected function Passes if a link with the specified label is found.
AssertContentTrait::assertLinkByHref protected function Passes if a link containing a given href (part) is found.
AssertContentTrait::assertNoDuplicateIds protected function Asserts that each HTML ID is used for just a single element.
AssertContentTrait::assertNoEscaped protected function Passes if raw text IS NOT found escaped on loaded page, fail otherwise.
AssertContentTrait::assertNoField protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked protected function Asserts that a checkbox field in the current page is not checked.
AssertContentTrait::assertNoLink protected function Passes if a link with the specified label is not found.
AssertContentTrait::assertNoLinkByHref protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected protected function Asserts that a select option in the current page is not checked.
AssertContentTrait::assertNoPattern protected function Triggers a pass if the perl regex pattern is not found in raw content.
AssertContentTrait::assertNoRaw protected function Passes if the raw text is NOT found on the loaded page, fail otherwise.
AssertContentTrait::assertNoText protected function Passes if the page (with HTML stripped) does not contains the text.
AssertContentTrait::assertNoTitle protected function Pass if the page title is not the given string.
AssertContentTrait::assertNoUniqueText protected function Passes if the text is found MORE THAN ONCE on the text version of the page.
AssertContentTrait::assertOption protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertOptionByText protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionWithDrupalSelector protected function Asserts that a select option in the current page exists.
AssertContentTrait::assertPattern protected function Triggers a pass if the Perl regex pattern is found in the raw content.
AssertContentTrait::assertRaw protected function Passes if the raw text IS found on the loaded page, fail otherwise.
AssertContentTrait::assertText protected function Passes if the page (with HTML stripped) contains the text.
AssertContentTrait::assertTextHelper protected function Helper for assertText and assertNoText.
AssertContentTrait::assertTextPattern protected function Asserts that a Perl regex pattern is found in the plain-text content.
AssertContentTrait::assertThemeOutput protected function Asserts themed output.
AssertContentTrait::assertTitle protected function Pass if the page title is the given string.
AssertContentTrait::assertUniqueText protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper protected function Helper for assertUniqueText and assertNoUniqueText.
AssertContentTrait::buildXPathQuery protected function Builds an XPath query.
AssertContentTrait::constructFieldXpath protected function Helper: Constructs an XPath for the given set of attributes and value.
AssertContentTrait::cssSelect protected function Searches elements using a CSS selector in the raw content.
AssertContentTrait::getAllOptions protected function Get all option elements, including nested options, in a select.
AssertContentTrait::getDrupalSettings protected function Gets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::getRawContent protected function Gets the current raw content.
AssertContentTrait::getSelectedItem protected function Get the selected value from a select field.
AssertContentTrait::getTextContent protected function Retrieves the plain-text content from the current raw content.
AssertContentTrait::parse protected function Parse content returned from curlExec using DOM and SimpleXML.
AssertContentTrait::removeWhiteSpace protected function Removes all white-space between HTML tags from the raw content.
AssertContentTrait::setDrupalSettings protected function Sets the value of drupalSettings for the currently-loaded page.
AssertContentTrait::setRawContent protected function Sets the raw content (e.g. HTML).
AssertContentTrait::xpath protected function Performs an xpath search on the contents of the internal browser.
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.
DateTimeHandlerTestBase::$fieldName protected static property Name of the field.
DateTimeHandlerTestBase::$fieldType protected static property Type of the field. 1
DateTimeHandlerTestBase::$map protected property Column map.
DateTimeHandlerTestBase::$modules protected static property Modules to install. Overrides ViewsKernelTestBase::$modules 1
DateTimeHandlerTestBase::$nodes protected property Nodes to test.
DateTimeHandlerTestBase::getRelativeDateValuesFromTimestamp protected function Returns an array formatted date_only values relative to timestamp.
DateTimeHandlerTestBase::getUTCEquivalentOfUserNowAsTimestamp protected function Returns UTC timestamp of user&#039;s TZ &#039;now&#039;.
DateTimeHandlerTestBase::setSiteTimezone protected function Sets the site timezone to a given timezone.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
FilterDateTest::$testViews public static property Views to be enabled. Overrides ViewsKernelTestBase::$testViews
FilterDateTest::$timezones protected static property An array of timezone extremes to test.
FilterDateTest::setUp protected function Create nodes with relative dates of yesterday, today, and tomorrow. Overrides DateTimeHandlerTestBase::setUp
FilterDateTest::testDateIs public function Tests date filter with date-only fields.
FilterDateTest::testDateOffsets public function Tests offsets with date-only fields.
FilterDateTest::updateNodesDateFieldsValues protected function Updates tests nodes date fields values.
KernelTestBase::$backupGlobals protected property Back up and restore any global variables that may be changed by tests.
KernelTestBase::$backupStaticAttributes protected property Back up and restore static class properties that may be changed by tests.
KernelTestBase::$backupStaticAttributesBlacklist protected property Contains a few static class properties for performance.
KernelTestBase::$classLoader protected property
KernelTestBase::$configImporter protected property @todo Move into Config test base class. 6
KernelTestBase::$configSchemaCheckerExclusions protected static property An array of config object names that are excluded from schema checking. 3
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$preserveGlobalState protected property Do not forward any global state from the parent process to the processes
that run the actual tests.
KernelTestBase::$root protected property The app root.
KernelTestBase::$runTestInSeparateProcess protected property Kernel tests are run in separate processes because they allow autoloading
of code from extensions. Running the test in a separate process isolates
this behavior from other tests. Subclasses should not override this
property.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 9
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 7
KernelTestBase::$vfsRoot protected property The virtual filesystem root directory.
KernelTestBase::assertPostConditions protected function 1
KernelTestBase::bootEnvironment protected function Bootstraps a basic test environment.
KernelTestBase::bootKernel protected function Bootstraps a kernel for a test. 1
KernelTestBase::config protected function Configuration accessor for tests. Returns non-overridden configuration.
KernelTestBase::disableModules protected function Disables modules for this test.
KernelTestBase::enableModules protected function Enables modules for this test. 1
KernelTestBase::getConfigSchemaExclusions protected function Gets the config schema exclusions for this test.
KernelTestBase::getDatabaseConnectionInfo protected function Returns the Database connection info to be used for this test. 2
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to install.
KernelTestBase::getModulesToEnable private static function Returns the modules to install for this test.
KernelTestBase::initFileCache protected function Initializes the FileCache component.
KernelTestBase::installConfig protected function Installs default configuration for a given list of modules.
KernelTestBase::installEntitySchema protected function Installs the storage schema for a specific entity type.
KernelTestBase::installSchema protected function Installs database tables from a module schema definition.
KernelTestBase::register public function Registers test-specific services. Overrides ServiceProviderInterface::register 27
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setInstallProfile protected function Sets the install profile and rebuilds the container to update it.
KernelTestBase::setSetting protected function Sets an in-memory Settings variable.
KernelTestBase::setUpBeforeClass public static function 1
KernelTestBase::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 2
KernelTestBase::stop Deprecated protected function Stops test execution.
KernelTestBase::tearDown protected function 6
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__get public function
KernelTestBase::__sleep public function Prevents serializing any properties.
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.
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.
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.
ViewsKernelTestBase::dataSet protected function Returns a very simple test dataset. 9
ViewsKernelTestBase::executeView protected function Executes a view.
ViewsKernelTestBase::orderResultSet protected function Orders a nested array containing a result set based on a given column.
ViewsKernelTestBase::schemaDefinition protected function Returns the schema definition. 6
ViewsKernelTestBase::setUpFixtures protected function Sets up the configuration and schema of views and views_test_data modules. 6
ViewsKernelTestBase::viewsData protected function Returns the views data definition. 23

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.