www.aleph1.co.uk Git - yaffs-website/blob - web/core/lib/Drupal/Core/Datetime/Element/Datetime.php

   1 <?php
   2
   3 namespace Drupal\Core\Datetime\Element;
   4
   5 use Drupal\Component\Utility\NestedArray;
   6 use Drupal\Core\Datetime\DrupalDateTime;
   7 use Drupal\Core\Form\FormStateInterface;
   8 use Drupal\Core\Datetime\Entity\DateFormat;
   9
  10 /**
  11  * Provides a datetime element.
  12  *
  13  * @FormElement("datetime")
  14  */
  15 class Datetime extends DateElementBase {
  16
  17   /**
  18    * @var \DateTimeInterface
  19    */
  20   protected static $dateExample;
  21
  22   /**
  23    * {@inheritdoc}
  24    */
  25   public function getInfo() {
  26     $date_format = '';
  27     $time_format = '';
  28     // Date formats cannot be loaded during install or update.
  29     if (!defined('MAINTENANCE_MODE')) {
  30       if ($date_format_entity = DateFormat::load('html_date')) {
  31         /** @var $date_format_entity \Drupal\Core\Datetime\DateFormatInterface */
  32         $date_format = $date_format_entity->getPattern();
  33       }
  34       if ($time_format_entity = DateFormat::load('html_time')) {
  35         /** @var $time_format_entity \Drupal\Core\Datetime\DateFormatInterface */
  36         $time_format = $time_format_entity->getPattern();
  37       }
  38     }
  39
  40     $class = get_class($this);
  41     return [
  42       '#input' => TRUE,
  43       '#element_validate' => [
  44         [$class, 'validateDatetime'],
  45       ],
  46       '#process' => [
  47         [$class, 'processDatetime'],
  48         [$class, 'processAjaxForm'],
  49         [$class, 'processGroup'],
  50       ],
  51       '#pre_render' => [
  52         [$class, 'preRenderGroup'],
  53       ],
  54       '#theme' => 'datetime_form',
  55       '#theme_wrappers' => ['datetime_wrapper'],
  56       '#date_date_format' => $date_format,
  57       '#date_date_element' => 'date',
  58       '#date_date_callbacks' => [],
  59       '#date_time_format' => $time_format,
  60       '#date_time_element' => 'time',
  61       '#date_time_callbacks' => [],
  62       '#date_year_range' => '1900:2050',
  63       '#date_increment' => 1,
  64       '#date_timezone' => '',
  65     ];
  66   }
  67
  68   /**
  69    * {@inheritdoc}
  70    */
  71   public static function valueCallback(&$element, $input, FormStateInterface $form_state) {
  72     if ($input !== FALSE) {
  73       $date_input  = $element['#date_date_element'] != 'none' && !empty($input['date']) ? $input['date'] : '';
  74       $time_input  = $element['#date_time_element'] != 'none' && !empty($input['time']) ? $input['time'] : '';
  75       $date_format = $element['#date_date_element'] != 'none' ? static::getHtml5DateFormat($element) : '';
  76       $time_format = $element['#date_time_element'] != 'none' ? static::getHtml5TimeFormat($element) : '';
  77       $timezone = !empty($element['#date_timezone']) ? $element['#date_timezone'] : NULL;
  78
  79       // Seconds will be omitted in a post in case there's no entry.
  80       if (!empty($time_input) && strlen($time_input) == 5) {
  81         $time_input .= ':00';
  82       }
  83
  84       try {
  85         $date_time_format = trim($date_format . ' ' . $time_format);
  86         $date_time_input = trim($date_input . ' ' . $time_input);
  87         $date = DrupalDateTime::createFromFormat($date_time_format, $date_time_input, $timezone);
  88       }
  89       catch (\Exception $e) {
  90         $date = NULL;
  91       }
  92       $input = [
  93         'date'   => $date_input,
  94         'time'   => $time_input,
  95         'object' => $date,
  96       ];
  97     }
  98     else {
  99       $date = $element['#default_value'];
 100       if ($date instanceof DrupalDateTime && !$date->hasErrors()) {
 101         $input = [
 102           'date'   => $date->format($element['#date_date_format']),
 103           'time'   => $date->format($element['#date_time_format']),
 104           'object' => $date,
 105         ];
 106       }
 107       else {
 108         $input = [
 109           'date'   => '',
 110           'time'   => '',
 111           'object' => NULL,
 112         ];
 113       }
 114     }
 115     return $input;
 116   }
 117
 118   /**
 119    * Expands a datetime element type into date and/or time elements.
 120    *
 121    * All form elements are designed to have sane defaults so any or all can be
 122    * omitted. Both the date and time components are configurable so they can be
 123    * output as HTML5 datetime elements or not, as desired.
 124    *
 125    * Examples of possible configurations include:
 126    *   HTML5 date and time:
 127    *     #date_date_element = 'date';
 128    *     #date_time_element = 'time';
 129    *   HTML5 datetime:
 130    *     #date_date_element = 'datetime';
 131    *     #date_time_element = 'none';
 132    *   HTML5 time only:
 133    *     #date_date_element = 'none';
 134    *     #date_time_element = 'time'
 135    *   Non-HTML5:
 136    *     #date_date_element = 'text';
 137    *     #date_time_element = 'text';
 138    *
 139    * Required settings:
 140    *   - #default_value: A DrupalDateTime object, adjusted to the proper local
 141    *     timezone. Converting a date stored in the database from UTC to the local
 142    *     zone and converting it back to UTC before storing it is not handled here.
 143    *     This element accepts a date as the default value, and then converts the
 144    *     user input strings back into a new date object on submission. No timezone
 145    *     adjustment is performed.
 146    * Optional properties include:
 147    *   - #date_date_format: A date format string that describes the format that
 148    *     should be displayed to the end user for the date. When using HTML5
 149    *     elements the format MUST use the appropriate HTML5 format for that
 150    *     element, no other format will work. See the format_date() function for a
 151    *     list of the possible formats and HTML5 standards for the HTML5
 152    *     requirements. Defaults to the right HTML5 format for the chosen element
 153    *     if a HTML5 element is used, otherwise defaults to
 154    *     DateFormat::load('html_date')->getPattern().
 155    *   - #date_date_element: The date element. Options are:
 156    *     - datetime: Use the HTML5 datetime element type.
 157    *     - datetime-local: Use the HTML5 datetime-local element type.
 158    *     - date: Use the HTML5 date element type.
 159    *     - text: No HTML5 element, use a normal text field.
 160    *     - none: Do not display a date element.
 161    *   - #date_date_callbacks: Array of optional callbacks for the date element.
 162    *     Can be used to add a jQuery datepicker.
 163    *   - #date_time_element: The time element. Options are:
 164    *     - time: Use a HTML5 time element type.
 165    *     - text: No HTML5 element, use a normal text field.
 166    *     - none: Do not display a time element.
 167    *   - #date_time_format: A date format string that describes the format that
 168    *     should be displayed to the end user for the time. When using HTML5
 169    *     elements the format MUST use the appropriate HTML5 format for that
 170    *     element, no other format will work. See the format_date() function for
 171    *     a list of the possible formats and HTML5 standards for the HTML5
 172    *     requirements. Defaults to the right HTML5 format for the chosen element
 173    *     if a HTML5 element is used, otherwise defaults to
 174    *     DateFormat::load('html_time')->getPattern().
 175    *   - #date_time_callbacks: An array of optional callbacks for the time
 176    *     element. Can be used to add a jQuery timepicker or an 'All day' checkbox.
 177    *   - #date_year_range: A description of the range of years to allow, like
 178    *     '1900:2050', '-3:+3' or '2000:+3', where the first value describes the
 179    *     earliest year and the second the latest year in the range. A year
 180    *     in either position means that specific year. A +/- value describes a
 181    *     dynamic value that is that many years earlier or later than the current
 182    *     year at the time the form is displayed. Used in jQueryUI datepicker year
 183    *     range and HTML5 min/max date settings. Defaults to '1900:2050'.
 184    *   - #date_increment: The increment to use for minutes and seconds, i.e.
 185    *    '15' would show only :00, :15, :30 and :45. Used for HTML5 step values and
 186    *     jQueryUI datepicker settings. Defaults to 1 to show every minute.
 187    *   - #date_timezone: The local timezone to use when creating dates. Generally
 188    *     this should be left empty and it will be set correctly for the user using
 189    *     the form. Useful if the default value is empty to designate a desired
 190    *     timezone for dates created in form processing. If a default date is
 191    *     provided, this value will be ignored, the timezone in the default date
 192    *     takes precedence. Defaults to the value returned by
 193    *     drupal_get_user_timezone().
 194    *
 195    * Example usage:
 196    * @code
 197    *   $form = array(
 198    *     '#type' => 'datetime',
 199    *     '#default_value' => new DrupalDateTime('2000-01-01 00:00:00'),
 200    *     '#date_date_element' => 'date',
 201    *     '#date_time_element' => 'none',
 202    *     '#date_year_range' => '2010:+3',
 203    *   );
 204    * @endcode
 205    *
 206    * @param array $element
 207    *   The form element whose value is being processed.
 208    * @param \Drupal\Core\Form\FormStateInterface $form_state
 209    *   The current state of the form.
 210    * @param array $complete_form
 211    *   The complete form structure.
 212    *
 213    * @return array
 214    *   The form element whose value has been processed.
 215    */
 216   public static function processDatetime(&$element, FormStateInterface $form_state, &$complete_form) {
 217     $format_settings = [];
 218     // The value callback has populated the #value array.
 219     $date = !empty($element['#value']['object']) ? $element['#value']['object'] : NULL;
 220
 221     // Set a fallback timezone.
 222     if ($date instanceof DrupalDateTime) {
 223       $element['#date_timezone'] = $date->getTimezone()->getName();
 224     }
 225     elseif (empty($element['#timezone'])) {
 226       $element['#date_timezone'] = drupal_get_user_timezone();
 227     }
 228
 229     $element['#tree'] = TRUE;
 230
 231     if ($element['#date_date_element'] != 'none') {
 232
 233       $date_format = $element['#date_date_element'] != 'none' ? static::getHtml5DateFormat($element) : '';
 234       $date_value = !empty($date) ? $date->format($date_format, $format_settings) : $element['#value']['date'];
 235
 236       // Creating format examples on every individual date item is messy, and
 237       // placeholders are invalid for HTML5 date and datetime, so an example
 238       // format is appended to the title to appear in tooltips.
 239       $extra_attributes = [
 240         'title' => t('Date (e.g. @format)', ['@format' => static::formatExample($date_format)]),
 241         'type' => $element['#date_date_element'],
 242       ];
 243
 244       // Adds the HTML5 date attributes.
 245       if ($date instanceof DrupalDateTime && !$date->hasErrors()) {
 246         $html5_min = clone($date);
 247         $range = static::datetimeRangeYears($element['#date_year_range'], $date);
 248         $html5_min->setDate($range[0], 1, 1)->setTime(0, 0, 0);
 249         $html5_max = clone($date);
 250         $html5_max->setDate($range[1], 12, 31)->setTime(23, 59, 59);
 251
 252         $extra_attributes += [
 253           'min' => $html5_min->format($date_format, $format_settings),
 254           'max' => $html5_max->format($date_format, $format_settings),
 255         ];
 256       }
 257
 258       $element['date'] = [
 259         '#type' => 'date',
 260         '#title' => t('Date'),
 261         '#title_display' => 'invisible',
 262         '#value' => $date_value,
 263         '#attributes' => $element['#attributes'] + $extra_attributes,
 264         '#required' => $element['#required'],
 265         '#size' => max(12, strlen($element['#value']['date'])),
 266         '#error_no_message' => TRUE,
 267         '#date_date_format' => $element['#date_date_format'],
 268       ];
 269
 270       // Allows custom callbacks to alter the element.
 271       if (!empty($element['#date_date_callbacks'])) {
 272         foreach ($element['#date_date_callbacks'] as $callback) {
 273           if (function_exists($callback)) {
 274             $callback($element, $form_state, $date);
 275           }
 276         }
 277       }
 278     }
 279
 280     if ($element['#date_time_element'] != 'none') {
 281
 282       $time_format = $element['#date_time_element'] != 'none' ? static::getHtml5TimeFormat($element) : '';
 283       $time_value = !empty($date) ? $date->format($time_format, $format_settings) : $element['#value']['time'];
 284
 285       // Adds the HTML5 attributes.
 286       $extra_attributes = [
 287         'title' => t('Time (e.g. @format)', ['@format' => static::formatExample($time_format)]),
 288         'type' => $element['#date_time_element'],
 289         'step' => $element['#date_increment'],
 290       ];
 291       $element['time'] = [
 292         '#type' => 'date',
 293         '#title' => t('Time'),
 294         '#title_display' => 'invisible',
 295         '#value' => $time_value,
 296         '#attributes' => $element['#attributes'] + $extra_attributes,
 297         '#required' => $element['#required'],
 298         '#size' => 12,
 299         '#error_no_message' => TRUE,
 300       ];
 301
 302       // Allows custom callbacks to alter the element.
 303       if (!empty($element['#date_time_callbacks'])) {
 304         foreach ($element['#date_time_callbacks'] as $callback) {
 305           if (function_exists($callback)) {
 306             $callback($element, $form_state, $date);
 307           }
 308         }
 309       }
 310     }
 311
 312     return $element;
 313   }
 314
 315   /**
 316    * {@inheritdoc}
 317    */
 318   public static function processAjaxForm(&$element, FormStateInterface $form_state, &$complete_form) {
 319     $element = parent::processAjaxForm($element, $form_state, $complete_form);
 320
 321     // Copy the #ajax settings to the child elements.
 322     if (isset($element['#ajax'])) {
 323       if (isset($element['date'])) {
 324         $element['date']['#ajax'] = $element['#ajax'];
 325       }
 326       if (isset($element['time'])) {
 327         $element['time']['#ajax'] = $element['#ajax'];
 328       }
 329     }
 330
 331     return $element;
 332   }
 333
 334   /**
 335    * Validation callback for a datetime element.
 336    *
 337    * If the date is valid, the date object created from the user input is set in
 338    * the form for use by the caller. The work of compiling the user input back
 339    * into a date object is handled by the value callback, so we can use it here.
 340    * We also have the raw input available for validation testing.
 341    *
 342    * @param array $element
 343    *   The form element whose value is being validated.
 344    * @param \Drupal\Core\Form\FormStateInterface $form_state
 345    *   The current state of the form.
 346    * @param array $complete_form
 347    *   The complete form structure.
 348    */
 349   public static function validateDatetime(&$element, FormStateInterface $form_state, &$complete_form) {
 350     $input_exists = FALSE;
 351     $input = NestedArray::getValue($form_state->getValues(), $element['#parents'], $input_exists);
 352     if ($input_exists) {
 353
 354       $title = !empty($element['#title']) ? $element['#title'] : '';
 355       $date_format = $element['#date_date_element'] != 'none' ? static::getHtml5DateFormat($element) : '';
 356       $time_format = $element['#date_time_element'] != 'none' ? static::getHtml5TimeFormat($element) : '';
 357       $format = trim($date_format . ' ' . $time_format);
 358
 359       // If there's empty input and the field is not required, set it to empty.
 360       if (empty($input['date']) && empty($input['time']) && !$element['#required']) {
 361         $form_state->setValueForElement($element, NULL);
 362       }
 363       // If there's empty input and the field is required, set an error. A
 364       // reminder of the required format in the message provides a good UX.
 365       elseif (empty($input['date']) && empty($input['time']) && $element['#required']) {
 366         $form_state->setError($element, t('The %field date is required. Please enter a date in the format %format.', ['%field' => $title, '%format' => static::formatExample($format)]));
 367       }
 368       else {
 369         // If the date is valid, set it.
 370         $date = $input['object'];
 371         if ($date instanceof DrupalDateTime && !$date->hasErrors()) {
 372           $form_state->setValueForElement($element, $date);
 373         }
 374         // If the date is invalid, set an error. A reminder of the required
 375         // format in the message provides a good UX.
 376         else {
 377           $form_state->setError($element, t('The %field date is invalid. Please enter a date in the format %format.', ['%field' => $title, '%format' => static::formatExample($format)]));
 378         }
 379       }
 380     }
 381   }
 382
 383   /**
 384    * Creates an example for a date format.
 385    *
 386    * This is centralized for a consistent method of creating these examples.
 387    *
 388    * @param string $format
 389    *
 390    * @return string
 391    */
 392   public static function formatExample($format) {
 393     if (!static::$dateExample) {
 394       static::$dateExample = new DrupalDateTime();
 395     }
 396     return static::$dateExample->format($format);
 397   }
 398
 399   /**
 400    * Retrieves the right format for a HTML5 date element.
 401    *
 402    * The format is important because these elements will not work with any other
 403    * format.
 404    *
 405    * @param string $element
 406    *   The $element to assess.
 407    *
 408    * @return string
 409    *   Returns the right format for the date element, or the original format
 410    *   if this is not a HTML5 element.
 411    */
 412   protected static function getHtml5DateFormat($element) {
 413     switch ($element['#date_date_element']) {
 414       case 'date':
 415         return DateFormat::load('html_date')->getPattern();
 416
 417       case 'datetime':
 418       case 'datetime-local':
 419         return DateFormat::load('html_datetime')->getPattern();
 420
 421       default:
 422         return $element['#date_date_format'];
 423     }
 424   }
 425
 426   /**
 427    * Retrieves the right format for a HTML5 time element.
 428    *
 429    * The format is important because these elements will not work with any other
 430    * format.
 431    *
 432    * @param string $element
 433    *   The $element to assess.
 434    *
 435    * @return string
 436    *   Returns the right format for the time element, or the original format
 437    *   if this is not a HTML5 element.
 438    */
 439   protected static function getHtml5TimeFormat($element) {
 440     switch ($element['#date_time_element']) {
 441       case 'time':
 442         return DateFormat::load('html_time')->getPattern();
 443
 444       default:
 445         return $element['#date_time_format'];
 446     }
 447   }
 448
 449 }