class DatetimeElementFormTest

Same name in other branches
  1. 8.9.x core/tests/Drupal/KernelTests/Core/Datetime/DatetimeElementFormTest.php \Drupal\KernelTests\Core\Datetime\DatetimeElementFormTest
  2. 10 core/tests/Drupal/KernelTests/Core/Datetime/DatetimeElementFormTest.php \Drupal\KernelTests\Core\Datetime\DatetimeElementFormTest
  3. 11.x core/tests/Drupal/KernelTests/Core/Datetime/DatetimeElementFormTest.php \Drupal\KernelTests\Core\Datetime\DatetimeElementFormTest

Tests DatetimeElement functionality.

@group Form

Hierarchy

Expanded class hierarchy of DatetimeElementFormTest

File

core/tests/Drupal/KernelTests/Core/Datetime/DatetimeElementFormTest.php, line 18

Namespace

Drupal\KernelTests\Core\Datetime
View source
class DatetimeElementFormTest extends KernelTestBase implements FormInterface, TrustedCallbackInterface {
    
    /**
     * Modules to enable.
     *
     * @var array
     */
    protected static $modules = [
        'datetime',
        'system',
    ];
    
    /**
     * Sets up the test.
     */
    protected function setUp() : void {
        parent::setUp();
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() {
        return 'test_datetime_element';
    }
    
    /**
     * {@inheritdoc}
     */
    public function datetimeDateCallbackTrusted(array &$element, FormStateInterface $form_state, DrupalDateTime $date = NULL) {
        $element['datetimeDateCallbackExecuted'] = [
            '#value' => TRUE,
        ];
        $form_state->set('datetimeDateCallbackExecuted', TRUE);
    }
    
    /**
     * {@inheritdoc}
     */
    public function datetimeDateCallback(array &$element, FormStateInterface $form_state, DrupalDateTime $date = NULL) {
        $element['datetimeDateCallbackExecuted'] = [
            '#value' => TRUE,
        ];
        $form_state->set('datetimeDateCallbackExecuted', TRUE);
    }
    
    /**
     * {@inheritdoc}
     */
    public function datetimeTimeCallbackTrusted(array &$element, FormStateInterface $form_state, DrupalDateTime $date = NULL) {
        $element['timeCallbackExecuted'] = [
            '#value' => TRUE,
        ];
        $form_state->set('timeCallbackExecuted', TRUE);
    }
    
    /**
     * {@inheritdoc}
     */
    public function datetimeTimeCallback(array &$element, FormStateInterface $form_state, DrupalDateTime $date = NULL) {
        $element['timeCallbackExecuted'] = [
            '#value' => TRUE,
        ];
        $form_state->set('timeCallbackExecuted', TRUE);
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state, string $date_callback = 'datetimeDateCallbackTrusted', string $time_callback = 'datetimeTimeCallbackTrusted') {
        $form['datetime_element'] = [
            '#title' => 'datelist test',
            '#type' => 'datetime',
            '#default_value' => new DrupalDateTime('2000-01-01 00:00:00'),
            '#date_date_format' => 'Y-m-d',
            '#date_time_format' => 'H:i:s',
            '#date_date_element' => 'HTML Date',
            '#date_time_element' => 'HTML Time',
            '#date_increment' => 1,
            '#date_date_callbacks' => [
                [
                    $this,
                    $date_callback,
                ],
            ],
            '#date_time_callbacks' => [
                [
                    $this,
                    $time_callback,
                ],
            ],
        ];
        // Element without specifying the default value.
        $form['simple_datetime_element'] = [
            '#type' => 'datetime',
            '#date_date_format' => 'Y-m-d',
            '#date_time_format' => 'H:i:s',
            '#date_date_element' => 'HTML Date',
            '#date_time_element' => 'HTML Time',
        ];
        $form['submit'] = [
            '#type' => 'submit',
            '#value' => t('Submit'),
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) {
    }
    
    /**
     * Form validation handler.
     *
     * @param array $form
     *   An associative array containing the structure of the form.
     * @param \Drupal\Core\Form\FormStateInterface $form_state
     *   The current state of the form.
     */
    public function validateForm(array &$form, FormStateInterface $form_state) {
    }
    
    /**
     * Tests that default handlers are added even if custom are specified.
     */
    public function testDatetimeElement() {
        $form_state = new FormState();
        $form = \Drupal::formBuilder()->buildForm($this, $form_state);
        $this->render($form);
        $this->assertTrue($form['datetime_element']['datetimeDateCallbackExecuted']['#value']);
        $this->assertTrue($form['datetime_element']['timeCallbackExecuted']['#value']);
        $this->assertTrue($form_state->get('datetimeDateCallbackExecuted'));
        $this->assertTrue($form_state->get('timeCallbackExecuted'));
    }
    
    /**
     * Tests that deprecations are raised if untrusted callbacks are used.
     *
     * @param string $date_callback
     *   Name of the callback to use for the date-time date callback.
     * @param string $time_callback
     *   Name of the callback to use for the date-time time callback.
     * @param string|null $expected_deprecation
     *   The expected deprecation message if a deprecation should be raised, or
     *   NULL if otherwise.
     *
     * @dataProvider providerUntrusted
     * @group legacy
     */
    public function testDatetimeElementUntrustedCallbacks(string $date_callback = 'datetimeDateCallbackTrusted', string $time_callback = 'datetimeTimeCallbackTrusted', string $expected_deprecation = NULL) : void {
        $form = \Drupal::formBuilder()->getForm($this, $date_callback, $time_callback);
        if ($expected_deprecation) {
            $this->expectDeprecation($expected_deprecation);
        }
        $this->render($form);
        $this->assertTrue($form['datetime_element']['datetimeDateCallbackExecuted']['#value']);
        $this->assertTrue($form['datetime_element']['timeCallbackExecuted']['#value']);
    }
    
    /**
     * Data provider for ::testDatetimeElementUntrustedCallbacks().
     *
     * @return string[][]
     *   Test cases.
     */
    public function providerUntrusted() : array {
        return [
            'untrusted date' => [
                'datetimeDateCallback',
                'datetimeTimeCallbackTrusted',
                sprintf('DateTime element #date_date_callbacks callbacks must be methods of a class that implements \\Drupal\\Core\\Security\\TrustedCallbackInterface or be an anonymous function. The callback was %s. Support for this callback implementation is deprecated in drupal:9.3.0 and will be removed in drupal:10.0.0. See https://www.drupal.org/node/3217966', Variable::callableToString([
                    $this,
                    'datetimeDateCallback',
                ])),
            ],
            'untrusted time' => [
                'datetimeDateCallbackTrusted',
                'datetimeTimeCallback',
                sprintf('DateTime element #date_time_callbacks callbacks must be methods of a class that implements \\Drupal\\Core\\Security\\TrustedCallbackInterface or be an anonymous function. The callback was %s. Support for this callback implementation is deprecated in drupal:9.3.0 and will be removed in drupal:10.0.0. See https://www.drupal.org/node/3217966', Variable::callableToString([
                    $this,
                    'datetimeTimeCallback',
                ])),
            ],
        ];
    }
    
    /**
     * Tests proper timezone handling of the Datetime element.
     */
    public function testTimezoneHandling() {
        // Render the form once with the site's timezone.
        $form = \Drupal::formBuilder()->getForm($this);
        $this->render($form);
        $this->assertEquals('Australia/Sydney', $form['datetime_element']['#date_timezone']);
        // Mimic a user with a different timezone than Australia/Sydney.
        date_default_timezone_set('UTC');
        $form = \Drupal::formBuilder()->getForm($this);
        $this->render($form);
        $this->assertEquals('UTC', $form['datetime_element']['#date_timezone']);
    }
    
    /**
     * {@inheritdoc}
     */
    public static function trustedCallbacks() {
        return [
            'datetimeDateCallbackTrusted',
            'datetimeTimeCallbackTrusted',
        ];
    }

}

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::getUrl protected function Get the current URL from the cURL handler. 1
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.
AssertLegacyTrait::assert Deprecated protected function
AssertLegacyTrait::assertEqual Deprecated protected function
AssertLegacyTrait::assertIdentical Deprecated protected function
AssertLegacyTrait::assertIdenticalObject Deprecated protected function
AssertLegacyTrait::assertNotEqual Deprecated protected function
AssertLegacyTrait::assertNotIdentical Deprecated protected function
AssertLegacyTrait::pass Deprecated protected function
AssertLegacyTrait::verbose Deprecated protected function
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.
DatetimeElementFormTest::$modules protected static property Modules to enable. Overrides KernelTestBase::$modules
DatetimeElementFormTest::buildForm public function Form constructor. Overrides FormInterface::buildForm
DatetimeElementFormTest::datetimeDateCallback public function
DatetimeElementFormTest::datetimeDateCallbackTrusted public function
DatetimeElementFormTest::datetimeTimeCallback public function
DatetimeElementFormTest::datetimeTimeCallbackTrusted public function
DatetimeElementFormTest::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
DatetimeElementFormTest::providerUntrusted public function Data provider for ::testDatetimeElementUntrustedCallbacks().
DatetimeElementFormTest::setUp protected function Sets up the test. Overrides KernelTestBase::setUp
DatetimeElementFormTest::submitForm public function Form submission handler. Overrides FormInterface::submitForm
DatetimeElementFormTest::testDatetimeElement public function Tests that default handlers are added even if custom are specified.
DatetimeElementFormTest::testDatetimeElementUntrustedCallbacks public function Tests that deprecations are raised if untrusted callbacks are used.
DatetimeElementFormTest::testTimezoneHandling public function Tests proper timezone handling of the Datetime element.
DatetimeElementFormTest::trustedCallbacks public static function Lists the trusted callbacks provided by the implementing class. Overrides TrustedCallbackInterface::trustedCallbacks
DatetimeElementFormTest::validateForm public function Form validation handler. Overrides FormInterface::validateForm
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
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.
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. 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 private function Bootstraps a kernel for a test.
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.
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. 3
KernelTestBase::getDatabasePrefix public function
KernelTestBase::getExtensionsForModules private function Returns Extension objects for $modules to enable.
KernelTestBase::getModulesToEnable private static function Returns the modules to enable 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 26
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. 3
KernelTestBase::stop protected function Stops test execution.
KernelTestBase::tearDown protected function 5
KernelTestBase::tearDownCloseDatabaseConnection public function @after
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
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::$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.
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.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
TrustedCallbackInterface::THROW_EXCEPTION constant Untrusted callbacks throw exceptions.
TrustedCallbackInterface::TRIGGER_SILENCED_DEPRECATION constant Untrusted callbacks trigger silenced E_USER_DEPRECATION errors.
TrustedCallbackInterface::TRIGGER_WARNING constant Untrusted callbacks trigger E_USER_WARNING errors.

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