You are here

class Date in Zircon Profile 8

Same name in this branch
  1. 8 vendor/symfony/validator/Constraints/Date.php \Symfony\Component\Validator\Constraints\Date
  2. 8 core/lib/Drupal/Core/Render/Element/Date.php \Drupal\Core\Render\Element\Date
  3. 8 core/modules/views/src/Plugin/views/filter/Date.php \Drupal\views\Plugin\views\filter\Date
  4. 8 core/modules/views/src/Plugin/views/sort/Date.php \Drupal\views\Plugin\views\sort\Date
  5. 8 core/modules/views/src/Plugin/views/argument/Date.php \Drupal\views\Plugin\views\argument\Date
  6. 8 core/modules/views/src/Plugin/views/field/Date.php \Drupal\views\Plugin\views\field\Date
  7. 8 core/modules/datetime/src/Plugin/views/filter/Date.php \Drupal\datetime\Plugin\views\filter\Date
  8. 8 core/modules/datetime/src/Plugin/views/sort/Date.php \Drupal\datetime\Plugin\views\sort\Date
  9. 8 core/modules/datetime/src/Plugin/views/argument/Date.php \Drupal\datetime\Plugin\views\Argument\Date
Same name and namespace in other branches
  1. 8.0 core/lib/Drupal/Core/Render/Element/Date.php \Drupal\Core\Render\Element\Date

Provides a form element for date selection.

Properties:

  • #default_value: An array with the keys: 'year', 'month', and 'day'. Defaults to the current date if no value is supplied.
$form['expiration'] = array(
  '#type' => 'date',
  '#title' => t('Content expiration'),
  '#default_value' => array(
    'year' => 2020,
    'month' => 2,
    'day' => 15,
  ),
);

Plugin annotation

@FormElement("date");

Hierarchy

Expanded class hierarchy of Date

24 string references to 'Date'
Date::getSortName in core/modules/views/src/Plugin/views/argument/Date.php
Return a description of how the argument would normally be sorted.
Datetime::processDatetime in core/lib/Drupal/Core/Datetime/Element/Datetime.php
Expands a datetime element type into date and/or time elements.
DbLogController::eventDetails in core/modules/dblog/src/Controller/DbLogController.php
Displays details about a specific database log message.
DbLogController::overview in core/modules/dblog/src/Controller/DbLogController.php
Displays a listing of database log messages.
DbLogTest::testDbLog in core/modules/dblog/src/Tests/DbLogTest.php
Tests Database Logging module functionality through interfaces.

... See full list

2 #type uses of Date
Datetime::processDatetime in core/lib/Drupal/Core/Datetime/Element/Datetime.php
Expands a datetime element type into date and/or time elements.
FormTestDisabledElementsForm::buildForm in core/modules/system/tests/modules/form_test/src/Form/FormTestDisabledElementsForm.php
Form constructor.

File

core/lib/Drupal/Core/Render/Element/Date.php, line 30
Contains \Drupal\Core\Render\Element\Date.

Namespace

Drupal\Core\Render\Element
View source
class Date extends FormElement {

  /**
   * {@inheritdoc}
   */
  public function getInfo() {
    $class = get_class($this);
    return [
      '#input' => TRUE,
      '#theme' => 'input__date',
      '#process' => [
        [
          $class,
          'processDate',
        ],
      ],
      '#pre_render' => [
        [
          $class,
          'preRenderDate',
        ],
      ],
      '#theme_wrappers' => [
        'form_element',
      ],
      '#attributes' => [
        'type' => 'date',
      ],
      '#date_date_format' => 'Y-m-d',
    ];
  }

  /**
   * Processes a date form element.
   *
   * @param array $element
   *   The form element to process. Properties used:
   *   - #attributes: An associative array containing:
   *     - type: The type of date field rendered.
   *   - #date_date_format: The date format used in PHP formats.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   * @param array $complete_form
   *   The complete form structure.
   *
   * @return array
   *   The processed element.
   */
  public static function processDate(&$element, FormStateInterface $form_state, &$complete_form) {

    // Attach JS support for the date field, if we can determine which date
    // format should be used.
    if ($element['#attributes']['type'] == 'date' && !empty($element['#date_date_format'])) {
      $element['#attached']['library'][] = 'core/drupal.date';
      $element['#attributes']['data-drupal-date-format'] = [
        $element['#date_date_format'],
      ];
    }
    return $element;
  }

  /**
   * Adds form-specific attributes to a 'date' #type element.
   *
   * Supports HTML5 types of 'date', 'datetime', 'datetime-local', and 'time'.
   * Falls back to a plain textfield with JS datepicker support. Used as a
   * sub-element by the datetime element type.
   *
   * @param array $element
   *   An associative array containing the properties of the element.
   *   Properties used: #title, #value, #options, #description, #required,
   *   #attributes, #id, #name, #type, #min, #max, #step, #value, #size.
   *
   * Note: The input "name" attribute needs to be sanitized before output, which
   *       is currently done by initializing Drupal\Core\Template\Attribute with
   *       all the attributes.
   *
   * @return array
   *   The $element with prepared variables ready for #theme 'input__date'.
   */
  public static function preRenderDate($element) {
    if (empty($element['#attributes']['type'])) {
      $element['#attributes']['type'] = 'date';
    }
    Element::setAttributes($element, array(
      'id',
      'name',
      'type',
      'min',
      'max',
      'step',
      'value',
      'size',
    ));
    static::setAttributes($element, array(
      'form-' . $element['#attributes']['type'],
    ));
    return $element;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
Date::getInfo public function Returns the element properties for this element. Overrides ElementInterface::getInfo
Date::preRenderDate public static function Adds form-specific attributes to a 'date' #type element.
Date::processDate public static function Processes a date form element.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FormElement::processAutocomplete public static function Adds autocomplete functionality to elements.
FormElement::processPattern public static function #process callback for #pattern form element property.
FormElement::validatePattern public static function #element_validate callback for #pattern form element property.
FormElement::valueCallback public static function Determines how user input is mapped to an element's #value property. Overrides FormElementInterface::valueCallback 15
PluginBase::$configuration protected property Configuration information passed into the plugin. 2
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::__construct public function Constructs a Drupal\Component\Plugin\PluginBase object. 69
RenderElement::preRenderAjaxForm public static function Adds Ajax information about an element to communicate with JavaScript.
RenderElement::preRenderGroup public static function Adds members of this group as actual elements for rendering.
RenderElement::processAjaxForm public static function Form element processing handler for the #ajax form property.
RenderElement::processGroup public static function Arranges elements into groups.
RenderElement::setAttributes public static function Sets a form element's class attribute. Overrides ElementInterface::setAttributes
StringTranslationTrait::$stringTranslation protected property The string translation service.
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.