class DatetimeFormElementTest

Tests static callbacks returns and form submission with datetime elements.

@coversDefaultClass \Drupal\Core\Datetime\Element\Datetime @group Datetime

Hierarchy

Expanded class hierarchy of DatetimeFormElementTest

File

core/tests/Drupal/KernelTests/Core/Datetime/Element/DatetimeFormElementTest.php, line 21

Namespace

Drupal\KernelTests\Core\Datetime\Element
View source
class DatetimeFormElementTest extends EntityKernelTestBase implements FormInterface {
    use EntityViewTrait;
    
    /**
     * Form builder service.
     *
     * @var \Drupal\Core\Form\FormBuilder
     */
    protected $formBuilder;
    
    /**
     * {@inheritdoc}
     */
    protected static $modules = [
        'system',
        'datetime',
    ];
    
    /**
     * {@inheritdoc}
     */
    public function setUp() : void {
        parent::setUp();
        $this->installEntitySchema('date_format');
        $this->installConfig([
            'system',
        ]);
        $this->formBuilder = $this->container
            ->get('form_builder');
    }
    
    /**
     * {@inheritdoc}
     */
    public function getFormId() : string {
        return 'datetime_form_element_test';
    }
    
    /**
     * {@inheritdoc}
     */
    public function buildForm(array $form, FormStateInterface $form_state) : array {
        // Test datetime-local element.
        $form['datetime_local_picker'] = [
            '#type' => 'datetime',
            '#date_date_element' => 'datetime-local',
            '#date_time_element' => 'none',
        ];
        $form['submit'] = [
            '#type' => 'submit',
            '#value' => 'Submit',
        ];
        return $form;
    }
    
    /**
     * {@inheritdoc}
     */
    public function submitForm(array &$form, FormStateInterface $form_state) : void {
    }
    
    /**
     * {@inheritdoc}
     */
    public function validateForm(array &$form, FormStateInterface $form_state) : void {
    }
    
    /**
     * Checks we have no errors on form submit.
     *
     * @covers ::validateDatetime
     */
    public function testNoErrorMetOnFormSubmit() : void {
        // No error expected when form elements have no value.
        $form_state = new FormState();
        $this->formBuilder
            ->submitForm($this, $form_state);
        $this->assertEmpty($form_state->getErrors());
        // No error expected when a datetime-local element has a valid value.
        $form_state = new FormState();
        $form_state->setValue('datetime_local_picker', [
            'date' => '2025-02-18T12:00',
        ]);
        $this->formBuilder
            ->submitForm($this, $form_state);
        $this->assertEmpty($form_state->getErrors());
    }
    
    /**
     * Checks expected values are returned by ::valueCallback().
     *
     * Test only applied to 'datetime-local' date element.
     *
     * @covers ::valueCallback
     */
    public function testDatetimeLocalValueCallback() : void {
        $element = [
            '#type' => 'datetime',
            '#date_date_element' => 'datetime-local',
            '#date_time_element' => 'none',
        ];
        $input = [
            'date' => '2025-02-18T12:00',
        ];
        $form_state = new FormState();
        $form_state->setValue('datetime_local_picker', [
            'date' => '2025-02-18T12:00',
        ]);
        $result = Datetime::valueCallback($element, $input, $form_state);
        $this->assertIsArray($result);
        $this->assertArrayHasKey('date', $result);
        $this->assertEquals('2025-02-18', $result['date']);
        $this->assertArrayHasKey('time', $result);
        $this->assertEquals('12:00:00', $result['time']);
        $this->assertArrayHasKey('object', $result);
        $this->assertNotEmpty($result['object']);
        $this->assertInstanceOf(DrupalDateTime::class, $result['object']);
    }
    
    /**
     * Checks expected values are returned by ::processDatetime().
     *
     * Test only applied to 'datetime-local' date element.
     *
     * @covers ::processDatetime
     */
    public function testDatetimeLocalProcessDatetime() : void {
        $form = [
            'datetime_local_picker' => [
                '#type' => 'datetime',
                '#date_date_element' => 'datetime-local',
                '#date_date_format' => 'Y-m-d',
                '#date_time_element' => 'none',
                '#date_time_format' => 'H:i:s',
                '#value' => [
                    'object' => new DrupalDateTime('2025-02-18T12:00'),
                    'date' => '2025-02-18',
                    'time' => '12:00:00',
                ],
                '#date_year_range' => '1900:2050',
                '#attributes' => [],
                '#required' => TRUE,
            ],
            'submit' => [
                '#type' => 'submit',
                '#value' => 'Submit',
            ],
        ];
        $element = $form['datetime_local_picker'];
        $form_state = new FormState();
        $form_state->setValue('datetime_local_picker', [
            'date' => '2025-02-18T12:00',
        ]);
        $result = Datetime::processDatetime($element, $form_state, $form);
        $this->assertIsArray($result);
        $this->assertArrayHasKey('date', $result);
        $this->assertIsArray($result['date']);
        $this->assertArrayHasKey('#error_no_message', $result['date']);
        $this->assertTrue($result['date']['#error_no_message']);
        $this->assertArrayHasKey('#attributes', $result['date']);
        $this->assertArrayHasKey('min', $result['date']['#attributes']);
        $this->assertEquals('1900-01-01T00:00:00', $result['date']['#attributes']['min']);
        $this->assertArrayHasKey('max', $result['date']['#attributes']);
        $this->assertEquals('2050-12-31T23:59:59', $result['date']['#attributes']['max']);
        $this->assertArrayNotHasKey('time', $result);
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Member alias 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 Deprecated 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 Deprecated 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 Deprecated 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 Deprecated protected function Asserts that a field does not exist with the given name or ID.
AssertContentTrait::assertNoFieldById Deprecated protected function Asserts that a field does not exist with the given ID and value.
AssertContentTrait::assertNoFieldByName Deprecated protected function Asserts that a field does not exist with the given name and value.
AssertContentTrait::assertNoFieldByXPath Deprecated protected function Asserts that a field does not exist or its value does not match, by XPath.
AssertContentTrait::assertNoFieldChecked Deprecated 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 Deprecated protected function Passes if a link containing a given href (part) is not found.
AssertContentTrait::assertNoLinkByHrefInMainRegion Deprecated protected function Passes if a link containing a given href is not found in the main region.
AssertContentTrait::assertNoOption Deprecated protected function Asserts that a select option in the current page does not exist.
AssertContentTrait::assertNoOptionSelected Deprecated 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 Deprecated 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 Deprecated protected function Asserts that a select option with the visible text exists.
AssertContentTrait::assertOptionSelected Deprecated protected function Asserts that a select option in the current page is checked.
AssertContentTrait::assertOptionSelectedWithDrupalSelector Deprecated 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 Deprecated 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 Deprecated protected function Passes if the text is found ONLY ONCE on the text version of the page.
AssertContentTrait::assertUniqueTextHelper Deprecated 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.
DatetimeFormElementTest::$formBuilder protected property Form builder service.
DatetimeFormElementTest::$modules protected static property Modules to install. Overrides EntityKernelTestBase::$modules
DatetimeFormElementTest::buildForm public function Form constructor. Overrides FormInterface::buildForm
DatetimeFormElementTest::getFormId public function Returns a unique string identifying the form. Overrides FormInterface::getFormId
DatetimeFormElementTest::setUp public function Overrides EntityKernelTestBase::setUp
DatetimeFormElementTest::submitForm public function Form submission handler. Overrides FormInterface::submitForm
DatetimeFormElementTest::testDatetimeLocalProcessDatetime public function Checks expected values are returned by ::processDatetime().
DatetimeFormElementTest::testDatetimeLocalValueCallback public function Checks expected values are returned by ::valueCallback().
DatetimeFormElementTest::testNoErrorMetOnFormSubmit public function Checks we have no errors on form submit.
DatetimeFormElementTest::validateForm public function Form validation handler. Overrides FormInterface::validateForm
EntityKernelTestBase::$entityTypeManager protected property The entity type manager service. 1
EntityKernelTestBase::$state protected property The state service.
EntityKernelTestBase::createUser protected function Creates a user.
EntityKernelTestBase::getHooksInfo protected function Returns the entity_test hook invocation info.
EntityKernelTestBase::installModule protected function Installs a module and refreshes services.
EntityKernelTestBase::refreshServices protected function Refresh services. 1
EntityKernelTestBase::uninstallModule protected function Uninstalls a module and refreshes services.
EntityTrait::$generatedIds protected property A list of entity IDs generated by self::generateRandomEntityId().
EntityTrait::generateRandomEntityId protected function Generates a random ID avoiding collisions.
EntityTrait::reloadEntity protected function Reloads the given entity from the storage and returns it.
EntityViewTrait::buildEntityView protected function Builds the renderable view of an entity.
ExpectDeprecationTrait::expectDeprecation public function Adds an expected deprecation.
ExpectDeprecationTrait::setUpErrorHandler public function Sets up the test error handler.
ExpectDeprecationTrait::tearDownErrorHandler public function Tears down the test error handler.
ExtensionListTestTrait::getModulePath protected function Gets the path for the specified module.
ExtensionListTestTrait::getThemePath protected function Gets the path for the specified theme.
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. 4
KernelTestBase::$container protected property
KernelTestBase::$databasePrefix protected property
KernelTestBase::$keyValue protected property The key_value service that must persist between container rebuilds.
KernelTestBase::$root protected property The app root.
KernelTestBase::$siteDirectory protected property
KernelTestBase::$strictConfigSchema protected property Set to TRUE to strict check all configuration saved. 10
KernelTestBase::$usesSuperUserAccessPolicy protected property Set to TRUE to make user 1 a super user. 2
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. 2
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 33
KernelTestBase::render protected function Renders a render array. 1
KernelTestBase::setDebugDumpHandler public static function Registers the dumper CLI handler when the DebugDump extension is enabled.
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::setUpFilesystem protected function Sets up the filesystem, so things like the file directory. 3
KernelTestBase::tearDown protected function 10
KernelTestBase::tearDownCloseDatabaseConnection public function Additional tear down method to close the connection at the end.
KernelTestBase::vfsDump protected function Dumps the current state of the virtual filesystem to STDOUT.
KernelTestBase::__construct public function
KernelTestBase::__sleep public function Prevents serializing any properties.
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.
StorageCopyTrait::replaceStorageContents protected static function Copy the configuration from one storage to another and remove stale items.
TestRequirementsTrait::getDrupalRoot protected static function Returns the Drupal root directory.
UserCreationTrait::checkPermissions protected function Checks whether a given list of permission names is valid. Aliased as: drupalCheckPermissions
UserCreationTrait::createAdminRole protected function Creates an administrative role. Aliased as: drupalCreateAdminRole
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 1
UserCreationTrait::grantPermissions protected function Grant permissions to a user role. Aliased as: drupalGrantPermissions
UserCreationTrait::setCurrentUser protected function Switch the current logged in user. Aliased as: drupalSetCurrentUser
UserCreationTrait::setUpCurrentUser protected function Creates a random user account and sets it as current user. Aliased as: drupalSetUpCurrentUser

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