class Datetime

Same name in other branches

9 core/lib/Drupal/Core/Datetime/Element/Datetime.php \Drupal\Core\Datetime\Element\Datetime
8.9.x core/lib/Drupal/Core/Datetime/Element/Datetime.php \Drupal\Core\Datetime\Element\Datetime
11.x core/lib/Drupal/Core/Datetime/Element/Datetime.php \Drupal\Core\Datetime\Element\Datetime

Provides a datetime element.

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
  - class \Drupal\Core\Render\Element\RenderElementBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\Core\Render\Element\ElementInterface
    - class \Drupal\Core\Render\Element\FormElementBase extends \Drupal\Core\Render\Element\RenderElementBase implements \Drupal\Core\Render\Element\FormElementInterface
      - class \Drupal\Core\Datetime\Element\DateElementBase extends \Drupal\Core\Render\Element\FormElementBase
        class \Drupal\Core\Datetime\Element\Datetime extends \Drupal\Core\Datetime\Element\DateElementBase uses \Drupal\Core\Security\DoTrustedCallbackTrait

Expanded class hierarchy of Datetime

61 string references to 'Datetime'

DateField::defineValueProcessPipeline in core/modules/datetime/src/Plugin/migrate/field/DateField.php
DateField::getFieldType in core/modules/datetime/src/Plugin/migrate/field/DateField.php
DateFieldTest::providerTestDefineValueProcessPipeline in core/modules/datetime/tests/src/Unit/Plugin/migrate/field/DateFieldTest.php: Provides data for testDefineValueProcessPipeline().
DateFilterTest::setUp in core/modules/datetime/tests/src/Functional/DateFilterTest.php
datetime.info.yml in core/modules/datetime/datetime.info.yml: core/modules/datetime/datetime.info.yml

... See full list

File

core/lib/Drupal/Core/Datetime/Element/Datetime.php, line 17

Namespace

Drupal\Core\Datetime\Element

View source

class Datetime extends DateElementBase {
    use DoTrustedCallbackTrait;
    
    /**
     * @var \DateTimeInterface
     */
    protected static $dateExample;
    
    /**
     * {@inheritdoc}
     */
    public function getInfo() {
        $date_format = '';
        $time_format = '';
        // Date formats cannot be loaded during install or update.
        if (!defined('MAINTENANCE_MODE')) {
            if ($date_format_entity = DateFormat::load('html_date')) {
                
                /** @var \Drupal\Core\Datetime\DateFormatInterface $date_format_entity */
                $date_format = $date_format_entity->getPattern();
            }
            if ($time_format_entity = DateFormat::load('html_time')) {
                
                /** @var \Drupal\Core\Datetime\DateFormatInterface $time_format_entity */
                $time_format = $time_format_entity->getPattern();
            }
        }
        $class = static::class;
        // Note that since this information is cached, the #date_timezone property
        // is not set here, as this needs to vary potentially by-user.
        return [
            '#input' => TRUE,
            '#element_validate' => [
                [
                    $class,
                    'validateDatetime',
                ],
            ],
            '#process' => [
                [
                    $class,
                    'processDatetime',
                ],
                [
                    $class,
                    'processAjaxForm',
                ],
                [
                    $class,
                    'processGroup',
                ],
            ],
            '#pre_render' => [
                [
                    $class,
                    'preRenderGroup',
                ],
            ],
            '#theme' => 'datetime_form',
            '#theme_wrappers' => [
                'datetime_wrapper',
            ],
            '#date_date_format' => $date_format,
            '#date_date_element' => 'date',
            '#date_date_callbacks' => [],
            '#date_time_format' => $time_format,
            '#date_time_element' => 'time',
            '#date_time_callbacks' => [],
            '#date_year_range' => '1900:2050',
            '#date_increment' => 1,
        ];
    }
    
    /**
     * {@inheritdoc}
     */
    public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
        $element += [
            '#date_timezone' => date_default_timezone_get(),
        ];
        if ($input !== FALSE) {
            $date_input = $element['#date_date_element'] != 'none' && !empty($input['date']) ? $input['date'] : '';
            $time_input = $element['#date_time_element'] != 'none' && !empty($input['time']) ? $input['time'] : '';
            $date_format = $element['#date_date_element'] != 'none' ? static::getHtml5DateFormat($element) : '';
            $time_format = $element['#date_time_element'] != 'none' ? static::getHtml5TimeFormat($element) : '';
            // Seconds will be omitted in a post in case there's no entry.
            if (!empty($time_input) && strlen($time_input) == 5) {
                $time_input .= ':00';
            }
            try {
                $date_time_format = trim($date_format . ' ' . $time_format);
                $date_time_input = trim($date_input . ' ' . $time_input);
                $date = DrupalDateTime::createFromFormat($date_time_format, $date_time_input, $element['#date_timezone']);
            } catch (\Exception $e) {
                $date = NULL;
            }
            $input = [
                'date' => $date_input,
                'time' => $time_input,
                'object' => $date,
            ];
        }
        else {
            $date = $element['#default_value'] ?? NULL;
            if ($date instanceof DrupalDateTime && !$date->hasErrors()) {
                $date->setTimezone(new \DateTimeZone($element['#date_timezone']));
                $input = [
                    'date' => $date->format($element['#date_date_format']),
                    'time' => $date->format($element['#date_time_format']),
                    'object' => $date,
                ];
            }
            else {
                $input = [
                    'date' => '',
                    'time' => '',
                    'object' => NULL,
                ];
            }
        }
        return $input;
    }
    
    /**
     * Expands a datetime element type into date and/or time elements.
     *
     * All form elements are designed to have sane defaults so any or all can be
     * omitted. Both the date and time components are configurable so they can be
     * output as HTML5 datetime elements or not, as desired.
     *
     * Examples of possible configurations include:
     *   HTML5 date and time:
     *     #date_date_element = 'date';
     *     #date_time_element = 'time';
     *   HTML5 datetime:
     *     #date_date_element = 'datetime';
     *     #date_time_element = 'none';
     *   HTML5 time only:
     *     #date_date_element = 'none';
     *     #date_time_element = 'time'
     *   Non-HTML5:
     *     #date_date_element = 'text';
     *     #date_time_element = 'text';
     *
     * Required settings:
     *   - #default_value: A DrupalDateTime object, adjusted to the proper local
     *     timezone. Converting a date stored in the database from UTC to the local
     *     zone and converting it back to UTC before storing it is not handled here.
     *     This element accepts a date as the default value, and then converts the
     *     user input strings back into a new date object on submission. No timezone
     *     adjustment is performed.
     * Optional properties include:
     *   - #date_date_format: A date format string that describes the format that
     *     should be displayed to the end user for the date. When using HTML5
     *     elements the format MUST use the appropriate HTML5 format for that
     *     element, no other format will work. See the
     *     DateFormatterInterface::format() function for a list of the possible
     *     formats and HTML5 standards for the HTML5 requirements. Defaults to the
     *     right HTML5 format for the chosen element if an HTML5 element is used,
     *     otherwise defaults to DateFormat::load('html_date')->getPattern().
     *   - #date_date_element: The date element. Options are:
     *     - datetime: Use the HTML5 datetime element type.
     *     - datetime-local: Use the HTML5 datetime-local element type.
     *     - date: Use the HTML5 date element type.
     *     - text: No HTML5 element, use a normal text field.
     *     - none: Do not display a date element.
     *   - #date_date_callbacks: Array of optional callbacks for the date element.
     *   - #date_time_element: The time element. Options are:
     *     - time: Use an HTML5 time element type.
     *     - text: No HTML5 element, use a normal text field.
     *     - none: Do not display a time element.
     *   - #date_time_format: A date format string that describes the format that
     *     should be displayed to the end user for the time. When using HTML5
     *     elements the format MUST use the appropriate HTML5 format for that
     *     element, no other format will work. See the
     *     DateFormatterInterface::format() function for a list of the possible
     *     formats and HTML5 standards for the HTML5 requirements. Defaults to the
     *     right HTML5 format for the chosen element if an HTML5 element is used,
     *     otherwise defaults to DateFormat::load('html_time')->getPattern().
     *   - #date_time_callbacks: An array of optional callbacks for the time
     *     element. Can be used to add a jQuery timepicker or an 'All day' checkbox.
     *   - #date_year_range: A description of the range of years to allow, like
     *     '1900:2050', '-3:+3' or '2000:+3', where the first value describes the
     *     earliest year and the second the latest year in the range. A year
     *     in either position means that specific year. A +/- value describes a
     *     dynamic value that is that many years earlier or later than the current
     *     year at the time the form is displayed. Used in HTML5 min/max date
     *     settings. Defaults to '1900:2050'.
     *   - #date_increment: The interval (step) to use when incrementing or
     *     decrementing time, in seconds. For example, if this value is set to 30,
     *     time increases (or decreases) in steps of 30 seconds (00:00:00,
     *     00:00:30, 00:01:00, and so on.) If this value is a multiple of 60, the
     *     "seconds"-component will not be shown in the input. Used for HTML5 step
     *     values. Defaults to 1 to show every second.
     *   - #date_timezone: The Time Zone Identifier (TZID) to use when displaying
     *     or interpreting dates, i.e: 'Asia/Kolkata'. Defaults to the value
     *     returned by date_default_timezone_get().
     *
     * Example usage:
     * @code
     *   $form = [
     *     '#type' => 'datetime',
     *     '#default_value' => new DrupalDateTime('2000-01-01 00:00:00'),
     *     '#date_date_element' => 'date',
     *     '#date_time_element' => 'none',
     *     '#date_year_range' => '2010:+3',
     *     '#date_timezone' => 'Asia/Kolkata',
     *   ];
     * @endcode
     *
     * @param array $element
     *   The form element whose value is being processed.
     * @param \Drupal\Core\Form\FormStateInterface $form_state
     *   The current state of the form.
     * @param array $complete_form
     *   The complete form structure.
     *
     * @return array
     *   The form element whose value has been processed.
     *
     * @see \Drupal\Core\Datetime\DateFormatterInterface::format()
     */
    public static function processDatetime(&$element, FormStateInterface $form_state, &$complete_form) {
        $format_settings = [];
        // The value callback has populated the #value array.
        $date = !empty($element['#value']['object']) ? $element['#value']['object'] : NULL;
        $element['#tree'] = TRUE;
        if ($element['#date_date_element'] != 'none') {
            $date_format = $element['#date_date_element'] != 'none' ? static::getHtml5DateFormat($element) : '';
            $date_value = !empty($date) ? $date->format($date_format, $format_settings) : $element['#value']['date'];
            // Creating format examples on every individual date item is messy, and
            // placeholders are invalid for HTML5 date and datetime, so an example
            // format is appended to the title to appear in tooltips.
            $extra_attributes = [
                'type' => $element['#date_date_element'],
            ];
            // Adds the HTML5 date attributes.
            if ($date instanceof DrupalDateTime && !$date->hasErrors()) {
                $html5_min = clone $date;
                $range = static::datetimeRangeYears($element['#date_year_range'], $date);
                $html5_min->setDate($range[0], 1, 1)
                    ->setTime(0, 0, 0);
                $html5_max = clone $date;
                $html5_max->setDate($range[1], 12, 31)
                    ->setTime(23, 59, 59);
                $extra_attributes += [
                    'min' => $html5_min->format($date_format, $format_settings),
                    'max' => $html5_max->format($date_format, $format_settings),
                ];
            }
            $element['date'] = [
                '#type' => 'date',
                '#title' => t('Date'),
                '#title_display' => 'invisible',
                '#value' => $date_value,
                '#attributes' => $element['#attributes'] + $extra_attributes,
                '#required' => $element['#required'],
                '#size' => max(12, strlen($element['#value']['date'])),
                '#error_no_message' => TRUE,
                '#date_date_format' => $element['#date_date_format'],
            ];
            // Allows custom callbacks to alter the element.
            if (!empty($element['#date_date_callbacks'])) {
                foreach ($element['#date_date_callbacks'] as $callback) {
                    $message = 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. See https://www.drupal.org/node/3217966', Variable::callableToString($callback));
                    StaticTrustedCallbackHelper::callback($callback, [
                        &$element,
                        $form_state,
                        $date,
                    ], $message);
                }
            }
        }
        if ($element['#date_time_element'] != 'none') {
            $time_format = $element['#date_time_element'] != 'none' ? static::getHtml5TimeFormat($element) : '';
            $time_value = !empty($date) ? $date->format($time_format, $format_settings) : $element['#value']['time'];
            // Adds the HTML5 attributes.
            $extra_attributes = [
                'type' => $element['#date_time_element'],
                'step' => $element['#date_increment'],
            ];
            $element['time'] = [
                '#type' => 'date',
                '#title' => t('Time'),
                '#title_display' => 'invisible',
                '#value' => $time_value,
                '#attributes' => $element['#attributes'] + $extra_attributes,
                '#required' => $element['#required'],
                '#size' => 12,
                '#error_no_message' => TRUE,
            ];
            // Allows custom callbacks to alter the element.
            if (!empty($element['#date_time_callbacks'])) {
                foreach ($element['#date_time_callbacks'] as $callback) {
                    $message = 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. See https://www.drupal.org/node/3217966', Variable::callableToString($callback));
                    StaticTrustedCallbackHelper::callback($callback, [
                        &$element,
                        $form_state,
                        $date,
                    ], $message);
                }
            }
        }
        return $element;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function processAjaxForm(&$element, FormStateInterface $form_state, &$complete_form) {
        $element = parent::processAjaxForm($element, $form_state, $complete_form);
        // Copy the #ajax settings to the child elements.
        if (isset($element['#ajax'])) {
            if (isset($element['date'])) {
                $element['date']['#ajax'] = $element['#ajax'];
            }
            if (isset($element['time'])) {
                $element['time']['#ajax'] = $element['#ajax'];
            }
        }
        return $element;
    }
    
    /**
     * Validation callback for a datetime element.
     *
     * If the date is valid, the date object created from the user input is set in
     * the form for use by the caller. The work of compiling the user input back
     * into a date object is handled by the value callback, so we can use it here.
     * We also have the raw input available for validation testing.
     *
     * @param array $element
     *   The form element whose value is being validated.
     * @param \Drupal\Core\Form\FormStateInterface $form_state
     *   The current state of the form.
     * @param array $complete_form
     *   The complete form structure.
     */
    public static function validateDatetime(&$element, FormStateInterface $form_state, &$complete_form) {
        $input_exists = FALSE;
        $input = NestedArray::getValue($form_state->getValues(), $element['#parents'], $input_exists);
        if ($input_exists) {
            $title = static::getElementTitle($element, $complete_form);
            // If there's empty input and the field is not required, set it to empty.
            if (empty($input['date']) && empty($input['time']) && !$element['#required']) {
                $form_state->setValueForElement($element, NULL);
            }
            elseif (empty($input['date']) && empty($input['time']) && $element['#required']) {
                $form_state->setError($element, t('The %field date is required.', [
                    '%field' => $title,
                ]));
            }
            else {
                // If the date is valid, set it.
                $date = $input['object'];
                if ($date instanceof DrupalDateTime && !$date->hasErrors()) {
                    $form_state->setValueForElement($element, $date);
                }
                else {
                    $form_state->setError($element, t('The %field date is invalid. Enter a date in the correct format.', [
                        '%field' => $title,
                    ]));
                }
            }
        }
    }
    
    /**
     * Creates an example for a date format.
     *
     * This is centralized for a consistent method of creating these examples.
     *
     * @param string $format
     *   The date format.
     *
     * @return string
     *
     * @deprecated in drupal:10.2.0 and is removed from drupal:11.0.0.
     *   There is no replacement.
     *
     * @see https://www.drupal.org/node/3385058
     */
    public static function formatExample($format) {
        @trigger_error(__METHOD__ . ' is deprecated in drupal:10.2.0 and is removed from drupal:11.0.0. There is no replacement. See https://www.drupal.org/node/3385058', E_USER_DEPRECATED);
        if (!static::$dateExample) {
            static::$dateExample = new DrupalDateTime();
        }
        return static::$dateExample->format($format);
    }
    
    /**
     * Retrieves the right format for an HTML5 date element.
     *
     * The format is important because these elements will not work with any other
     * format.
     *
     * @param array $element
     *   The $element to assess.
     *
     * @return string
     *   Returns the right format for the date element, or the original format
     *   if this is not an HTML5 element.
     */
    protected static function getHtml5DateFormat($element) {
        switch ($element['#date_date_element']) {
            case 'date':
                return DateFormat::load('html_date')->getPattern();
            case 'datetime':
            case 'datetime-local':
                return DateFormat::load('html_datetime')->getPattern();
            default:
                return $element['#date_date_format'];
        }
    }
    
    /**
     * Retrieves the right format for an HTML5 time element.
     *
     * The format is important because these elements will not work with any other
     * format.
     *
     * @param array $element
     *   The $element to assess.
     *
     * @return string
     *   Returns the right format for the time element, or the original format
     *   if this is not an HTML5 element.
     */
    protected static function getHtml5TimeFormat($element) {
        switch ($element['#date_time_element']) {
            case 'time':
                return DateFormat::load('html_time')->getPattern();
            default:
                return $element['#date_time_format'];
        }
    }

}

Members

Title Sort descending	Deprecated	Modifiers	Object type	Summary	Overriden Title	Overrides
DateElementBase::datetimeRangeYears		protected static	function	Specifies the start and end year to use as a date range.
DateElementBase::getElementTitle		protected static	function	Returns the most relevant title of a datetime element.
Datetime::$dateExample		protected static	property
Datetime::formatExample	Deprecated	public static	function	Creates an example for a date format.
Datetime::getHtml5DateFormat		protected static	function	Retrieves the right format for an HTML5 date element.
Datetime::getHtml5TimeFormat		protected static	function	Retrieves the right format for an HTML5 time element.
Datetime::getInfo		public	function		Overrides ElementInterface::getInfo
Datetime::processAjaxForm		public static	function		Overrides RenderElementBase::processAjaxForm
Datetime::processDatetime		public static	function	Expands a datetime element type into date and/or time elements.
Datetime::validateDatetime		public static	function	Validation callback for a datetime element.
Datetime::valueCallback		public static	function		Overrides FormElementBase::valueCallback
DoTrustedCallbackTrait::doTrustedCallback		public	function	Performs a callback.
FormElementBase::processAutocomplete		public static	function	Adds autocomplete functionality to elements.		1
FormElementBase::processPattern		public static	function	#process callback for #pattern form element property.		1
FormElementBase::validatePattern		public static	function	#element_validate callback for #pattern form element property.		1
PluginInspectionInterface::getPluginDefinition		public	function	Gets the definition of the plugin implementation.		6
PluginInspectionInterface::getPluginId		public	function	Gets the plugin ID of the plugin instance.		2
RenderElementBase::preRenderAjaxForm		public static	function	Adds Ajax information about an element to communicate with JavaScript.		2
RenderElementBase::preRenderGroup		public static	function	Adds members of this group as actual elements for rendering.		2
RenderElementBase::processGroup		public static	function	Arranges elements into groups.		2
RenderElementBase::setAttributes		public static	function		Overrides ElementInterface::setAttributes	2

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

class Datetime

Hierarchy

File

Namespace

Members

Search drupal 10

API Navigation

Breadcrumb

class Datetime

Hierarchy

File

Namespace

Members

Search drupal 10

API Navigation