DateTimePlus.php 20.6 KB
Newer Older
1
2
3
<?php

namespace Drupal\Component\Datetime;
4
use Drupal\Component\Utility\ToStringTrait;
5
6

/**
7
 * Wraps DateTime().
8
 *
9
 * This class wraps the PHP DateTime class with more flexible initialization
10
11
12
13
14
 * parameters, allowing a date to be created from an existing date object,
 * a timestamp, a string with an unknown format, a string with a known
 * format, or an array of date parts. It also adds an errors array
 * and a __toString() method to the date object.
 *
15
 * This class is less lenient than the DateTime class. It changes
16
 * the default behavior for handling date values like '2011-00-00'.
17
 * The DateTime class would convert that value to '2010-11-30' and report
18
19
 * a warning but not an error. This extension treats that as an error.
 *
20
 * As with the DateTime class, a date object may be created even if it has
21
22
23
24
25
 * errors. It has an errors array attached to it that explains what the
 * errors are. This is less disruptive than allowing datetime exceptions
 * to abort processing. The calling script can decide what to do about
 * errors using hasErrors() and getErrors().
 */
26
class DateTimePlus {
27

28
29
  use ToStringTrait;

30
31
  const FORMAT   = 'Y-m-d H:i:s';

32
33
34
35
36
37
38
39
40
  /**
   * A RFC7231 Compliant date.
   *
   * http://tools.ietf.org/html/rfc7231#section-7.1.1.1
   *
   * Example: Sun, 06 Nov 1994 08:49:37 GMT
   */
  const RFC7231 = 'D, d M Y H:i:s \G\M\T';

41
42
43
  /**
   * An array of possible date parts.
   */
44
  protected static $dateParts = [
45
46
47
48
49
50
    'year',
    'month',
    'day',
    'hour',
    'minute',
    'second',
51
  ];
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90

  /**
   * The value of the time value passed to the constructor.
   */
  protected $inputTimeRaw = '';

  /**
   * The prepared time, without timezone, for this date.
   */
  protected $inputTimeAdjusted = '';

  /**
   * The value of the timezone passed to the constructor.
   */
  protected $inputTimeZoneRaw = '';

  /**
   * The prepared timezone object used to construct this date.
   */
  protected $inputTimeZoneAdjusted = '';

  /**
   * The value of the format passed to the constructor.
   */
  protected $inputFormatRaw = '';

  /**
   * The prepared format, if provided.
   */
  protected $inputFormatAdjusted = '';

  /**
   * The value of the language code passed to the constructor.
   */
  protected $langcode = NULL;

  /**
   * An array of errors encountered when creating this date.
   */
91
  protected $errors = [];
92

93
94
95
96
97
98
99
  /**
   * The DateTime object.
   *
   * @var \DateTime
   */
  protected $dateTimeObject = NULL;

100
101
  /**
   * Creates a date object from an input date object.
102
   *
103
104
105
106
   * @param \DateTime $datetime
   *   A DateTime object.
   * @param array $settings
   *   @see __construct()
107
108
109
   *
   * @return static
   *   A new DateTimePlus object.
110
   */
111
  public static function createFromDateTime(\DateTime $datetime, $settings = []) {
112
113
114
115
116
117
118
119
120
121
    return new static($datetime->format(static::FORMAT), $datetime->getTimezone(), $settings);
  }

  /**
   * Creates a date object from an array of date parts.
   *
   * Converts the input value into an ISO date, forcing a full ISO
   * date even if some values are missing.
   *
   * @param array $date_parts
122
   *   An array of date parts, like ('year' => 2014, 'month' => 4).
123
   * @param mixed $timezone
124
125
   *   (optional) \DateTimeZone object, time zone string or NULL. NULL uses the
   *   default system time zone. Defaults to NULL.
126
   * @param array $settings
127
128
129
130
   *   (optional) A keyed array for settings, suitable for passing on to
   *   __construct().
   *
   * @return static
131
132
   *   A new DateTimePlus object.
   *
133
   * @throws \InvalidArgumentException
134
   *   If the array date values or value combination is not correct.
135
   */
136
  public static function createFromArray(array $date_parts, $timezone = NULL, $settings = []) {
137
138
139
    $date_parts = static::prepareArray($date_parts, TRUE);
    if (static::checkArray($date_parts)) {
      // Even with validation, we can end up with a value that the
140
      // DateTime class won't handle, like a year outside the range
141
142
143
144
145
146
      // of -9999 to 9999, which will pass checkdate() but
      // fail to construct a date object.
      $iso_date = static::arrayToISO($date_parts);
      return new static($iso_date, $timezone, $settings);
    }
    else {
147
      throw new \InvalidArgumentException('The array contains invalid values.');
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
    }
  }

  /**
   * Creates a date object from timestamp input.
   *
   * The timezone of a timestamp is always UTC. The timezone for a
   * timestamp indicates the timezone used by the format() method.
   *
   * @param int $timestamp
   *   A UNIX timestamp.
   * @param mixed $timezone
   *   @see __construct()
   * @param array $settings
   *   @see __construct()
163
164
165
166
   *
   * @return static
   *   A new DateTimePlus object.
   *
167
   * @throws \InvalidArgumentException
168
   *   If the timestamp is not numeric.
169
   */
170
  public static function createFromTimestamp($timestamp, $timezone = NULL, $settings = []) {
171
    if (!is_numeric($timestamp)) {
172
      throw new \InvalidArgumentException('The timestamp must be numeric.');
173
174
175
176
177
178
179
180
181
    }
    $datetime = new static('', $timezone, $settings);
    $datetime->setTimestamp($timestamp);
    return $datetime;
  }

  /**
   * Creates a date object from an input format.
   *
182
183
   * @param string $format
   *   PHP date() type format for parsing the input. This is recommended
184
185
   *   to use things like negative years, which php's parser fails on, or
   *   any other specialized input with a known format. If provided the
186
   *   date will be created using the createFromFormat() method.
187
   *   @see http://php.net/manual/datetime.createfromformat.php
188
189
190
191
   * @param mixed $time
   *   @see __construct()
   * @param mixed $timezone
   *   @see __construct()
192
193
194
195
196
197
198
199
   * @param array $settings
   *   - validate_format: (optional) Boolean choice to validate the
   *     created date using the input format. The format used in
   *     createFromFormat() allows slightly different values than format().
   *     Using an input format that works in both functions makes it
   *     possible to a validation step to confirm that the date created
   *     from a format string exactly matches the input. This option
   *     indicates the format can be used for validation. Defaults to TRUE.
200
   *   @see __construct()
201
202
203
204
   *
   * @return static
   *   A new DateTimePlus object.
   *
205
206
207
208
   * @throws \InvalidArgumentException
   *   If the a date cannot be created from the given format.
   * @throws \UnexpectedValueException
   *   If the created date does not match the input value.
209
   */
210
  public static function createFromFormat($format, $time, $timezone = NULL, $settings = []) {
211
212
213
214
215
216
217
218
219
    if (!isset($settings['validate_format'])) {
      $settings['validate_format'] = TRUE;
    }

    // Tries to create a date from the format and use it if possible.
    // A regular try/catch won't work right here, if the value is
    // invalid it doesn't return an exception.
    $datetimeplus = new static('', $timezone, $settings);

220
    $date = \DateTime::createFromFormat($format, $time, $datetimeplus->getTimezone());
221
    if (!$date instanceof \DateTime) {
222
      throw new \InvalidArgumentException('The date cannot be created from a format.');
223
224
    }
    else {
225
226
227
228
229
      // Functions that parse date is forgiving, it might create a date that
      // is not exactly a match for the provided value, so test for that by
      // re-creating the date/time formatted string and comparing it to the input. For
      // instance, an input value of '11' using a format of Y (4 digits) gets
      // created as '0011' instead of '2011'.
230
      if ($date instanceof DateTimePlus) {
231
232
        $test_time = $date->format($format, $settings);
      }
233
      elseif ($date instanceof \DateTime) {
234
235
        $test_time = $date->format($format);
      }
236
237
238
      $datetimeplus->setTimestamp($date->getTimestamp());
      $datetimeplus->setTimezone($date->getTimezone());

239
      if ($settings['validate_format'] && $test_time != $time) {
240
        throw new \UnexpectedValueException('The created date does not match the input value.');
241
242
243
244
245
246
247
248
249
      }
    }
    return $datetimeplus;
  }

  /**
   * Constructs a date object set to a requested date and timezone.
   *
   * @param string $time
250
   *   (optional) A date/time string. Defaults to 'now'.
251
   * @param mixed $timezone
252
   *   (optional) \DateTimeZone object, time zone string or NULL. NULL uses the
253
254
255
256
257
   *   default system time zone. Defaults to NULL. Note that the $timezone
   *   parameter and the current timezone are ignored when the $time parameter
   *   either is a UNIX timestamp (e.g. @946684800) or specifies a timezone
   *   (e.g. 2010-01-28T15:00:00+02:00).
   *   @see http://php.net/manual/en/datetime.construct.php
258
   * @param array $settings
259
   *   (optional) Keyed array of settings. Defaults to empty array.
260
261
   *   - langcode: (optional) String two letter language code used to control
   *     the result of the format(). Defaults to NULL.
262
263
264
   *   - debug: (optional) Boolean choice to leave debug values in the
   *     date object for debugging purposes. Defaults to FALSE.
   */
265
  public function __construct($time = 'now', $timezone = NULL, $settings = []) {
266
267
268
269
270

    // Unpack settings.
    $this->langcode = !empty($settings['langcode']) ? $settings['langcode'] : NULL;

    // Massage the input values as necessary.
271
272
    $prepared_time = $this->prepareTime($time);
    $prepared_timezone = $this->prepareTimezone($timezone);
273

274
    try {
275
      $this->errors = [];
276
277
278
      if (!empty($prepared_time)) {
        $test = date_parse($prepared_time);
        if (!empty($test['errors'])) {
279
          $this->errors = $test['errors'];
280
281
        }
      }
282

283
      if (empty($this->errors)) {
284
        $this->dateTimeObject = new \DateTime($prepared_time, $prepared_timezone);
285
      }
286
    }
287
288
    catch (\Exception $e) {
      $this->errors[] = $e->getMessage();
289
290
291
292
293
294
295
    }

    // Clean up the error messages.
    $this->checkErrors();
  }

  /**
296
   * Renders the timezone name.
297
   *
298
   * @return string
299
   */
300
  public function render() {
301
    return $this->format(static::FORMAT) . ' ' . $this->getTimeZone()->getName();
302
303
  }

304
305
306
307
308
309
310
311
312
313
314
315
316
  /**
   * Implements the magic __call method.
   *
   * Passes through all unknown calls onto the DateTime object.
   */
  public function __call($method, $args) {
    // @todo consider using assert() as per https://www.drupal.org/node/2451793.
    if (!isset($this->dateTimeObject)) {
      throw new \Exception('DateTime object not set.');
    }
    if (!method_exists($this->dateTimeObject, $method)) {
      throw new \BadMethodCallException(sprintf('Call to undefined method %s::%s()', get_class($this), $method));
    }
317
    return call_user_func_array([$this->dateTimeObject, $method], $args);
318
319
  }

320
321
322
323
  /**
   * Returns the difference between two DateTimePlus objects.
   *
   * @param \Drupal\Component\Datetime\DateTimePlus|\DateTime $datetime2
324
   *   The date to compare to.
325
   * @param bool $absolute
326
   *   Should the interval be forced to be positive?
327
328
   *
   * @return \DateInterval
329
   *   A DateInterval object representing the difference between the two dates.
330
331
332
333
334
335
336
337
338
339
340
341
342
343
   *
   * @throws \BadMethodCallException
   *    If the input isn't a DateTime or DateTimePlus object.
   */
  public function diff($datetime2, $absolute = FALSE) {
    if ($datetime2 instanceof DateTimePlus) {
      $datetime2 = $datetime2->dateTimeObject;
    }
    if (!($datetime2 instanceof \DateTime)) {
      throw new \BadMethodCallException(sprintf('Method %s expects parameter 1 to be a \DateTime or \Drupal\Component\Datetime\DateTimePlus object', __METHOD__));
    }
    return $this->dateTimeObject->diff($datetime2, $absolute);
  }

344
345
346
347
348
349
350
351
352
  /**
   * Implements the magic __callStatic method.
   *
   * Passes through all unknown static calls onto the DateTime object.
   */
  public static function __callStatic($method, $args) {
    if (!method_exists('\DateTime', $method)) {
      throw new \BadMethodCallException(sprintf('Call to undefined method %s::%s()', get_called_class(), $method));
    }
353
    return call_user_func_array(['\DateTime', $method], $args);
354
355
356
357
358
359
360
361
362
363
364
  }

  /**
   * Implements the magic __clone method.
   *
   * Deep-clones the DateTime object we're wrapping.
   */
  public function __clone() {
    $this->dateTimeObject = clone($this->dateTimeObject);
  }

365
366
367
368
369
370
371
372
373
  /**
   * Prepares the input time value.
   *
   * Changes the input value before trying to use it, if necessary.
   * Can be overridden to handle special cases.
   *
   * @param mixed $time
   *   An input value, which could be a timestamp, a string,
   *   or an array of date parts.
374
375
376
   *
   * @return mixed
   *   The massaged time.
377
378
   */
  protected function prepareTime($time) {
379
    return $time;
380
381
382
383
384
385
  }

  /**
   * Prepares the input timezone value.
   *
   * Changes the timezone before trying to use it, if necessary.
386
   * Most importantly, makes sure there is a valid timezone
387
388
389
390
   * object before moving further.
   *
   * @param mixed $timezone
   *   Either a timezone name or a timezone object or NULL.
391
392
393
   *
   * @return \DateTimeZone
   *   The massaged time zone.
394
395
396
   */
  protected function prepareTimezone($timezone) {
    // If the input timezone is a valid timezone object, use it.
397
    if ($timezone instanceof \DateTimezone) {
398
399
400
401
402
403
404
405
406
407
      $timezone_adjusted = $timezone;
    }

    // Allow string timezone input, and create a timezone from it.
    elseif (!empty($timezone) && is_string($timezone)) {
      $timezone_adjusted = new \DateTimeZone($timezone);
    }

    // Default to the system timezone when not explicitly provided.
    // If the system timezone is missing, use 'UTC'.
408
    if (empty($timezone_adjusted) || !$timezone_adjusted instanceof \DateTimezone) {
409
410
411
412
413
414
      $system_timezone = date_default_timezone_get();
      $timezone_name = !empty($system_timezone) ? $system_timezone : 'UTC';
      $timezone_adjusted = new \DateTimeZone($timezone_name);
    }

    // We are finally certain that we have a usable timezone.
415
    return $timezone_adjusted;
416
417
418
419
420
421
422
423
424
425
  }

  /**
   * Prepares the input format value.
   *
   * Changes the input format before trying to use it, if necessary.
   * Can be overridden to handle special cases.
   *
   * @param string $format
   *   A PHP format string.
426
427
428
   *
   * @return string
   *   The massaged PHP format string.
429
430
   */
  protected function prepareFormat($format) {
431
    return $format;
432
433
434
435
436
437
438
439
440
441
442
  }


  /**
   * Examines getLastErrors() to see what errors to report.
   *
   * Two kinds of errors are important: anything that DateTime
   * considers an error, and also a warning that the date was invalid.
   * PHP creates a valid date from invalid data with only a warning,
   * 2011-02-30 becomes 2011-03-03, for instance, but we don't want that.
   *
443
   * @see http://php.net/manual/time.getlasterrors.php
444
445
   */
  public function checkErrors() {
446
    $errors = \DateTime::getLastErrors();
447
    if (!empty($errors['errors'])) {
448
      $this->errors = array_merge($this->errors, $errors['errors']);
449
450
451
452
453
454
455
456
    }
    // Most warnings are messages that the date could not be parsed
    // which causes it to be altered. For validation purposes, a warning
    // as bad as an error, because it means the constructed date does
    // not match the input value.
    if (!empty($errors['warnings'])) {
      $this->errors[] = 'The date is invalid.';
    }
457
458

    $this->errors = array_values(array_unique($this->errors));
459
460
461
462
  }

  /**
   * Detects if there were errors in the processing of this date.
463
   *
alexpott's avatar
alexpott committed
464
   * @return bool
465
466
   *   TRUE if there were errors in the processing of this date, FALSE
   *   otherwise.
467
468
469
470
471
472
   */
  public function hasErrors() {
    return (boolean) count($this->errors);
  }

  /**
473
   * Gets error messages.
474
475
   *
   * Public function to return the error messages.
476
477
478
   *
   * @return array
   *   An array of errors encountered when creating this date.
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
   */
  public function getErrors() {
    return $this->errors;
  }

  /**
   * Creates an ISO date from an array of values.
   *
   * @param array $array
   *   An array of date values keyed by date part.
   * @param bool $force_valid_date
   *   (optional) Whether to force a full date by filling in missing
   *   values. Defaults to FALSE.
   *
   * @return string
   *   The date as an ISO string.
   */
  public static function arrayToISO($array, $force_valid_date = FALSE) {
    $array = static::prepareArray($array, $force_valid_date);
    $input_time = '';
    if ($array['year'] !== '') {
      $input_time = static::datePad(intval($array['year']), 4);
      if ($force_valid_date || $array['month'] !== '') {
        $input_time .= '-' . static::datePad(intval($array['month']));
        if ($force_valid_date || $array['day'] !== '') {
          $input_time .= '-' . static::datePad(intval($array['day']));
        }
      }
    }
    if ($array['hour'] !== '') {
      $input_time .= $input_time ? 'T' : '';
      $input_time .= static::datePad(intval($array['hour']));
      if ($force_valid_date || $array['minute'] !== '') {
        $input_time .= ':' . static::datePad(intval($array['minute']));
        if ($force_valid_date || $array['second'] !== '') {
          $input_time .= ':' . static::datePad(intval($array['second']));
        }
      }
    }
    return $input_time;
  }

  /**
   * Creates a complete array from a possibly incomplete array of date parts.
   *
   * @param array $array
   *   An array of date values keyed by date part.
   * @param bool $force_valid_date
   *   (optional) Whether to force a valid date by filling in missing
   *   values with valid values or just to use empty values instead.
   *   Defaults to FALSE.
   *
   * @return array
   *   A complete array of date parts.
   */
  public static function prepareArray($array, $force_valid_date = FALSE) {
    if ($force_valid_date) {
      $now = new \DateTime();
537
      $array += [
538
539
540
541
542
543
        'year'   => $now->format('Y'),
        'month'  => 1,
        'day'    => 1,
        'hour'   => 0,
        'minute' => 0,
        'second' => 0,
544
      ];
545
546
    }
    else {
547
      $array += [
548
549
550
551
552
553
        'year'   => '',
        'month'  => '',
        'day'    => '',
        'hour'   => '',
        'minute' => '',
        'second' => '',
554
      ];
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
    }
    return $array;
  }

  /**
   * Checks that arrays of date parts will create a valid date.
   *
   * Checks that an array of date parts has a year, month, and day,
   * and that those values create a valid date. If time is provided,
   * verifies that the time values are valid. Sort of an
   * equivalent to checkdate().
   *
   * @param array $array
   *   An array of datetime values keyed by date part.
   *
570
   * @return bool
571
572
573
574
575
576
577
578
579
580
581
582
583
584
   *   TRUE if the datetime parts contain valid values, otherwise FALSE.
   */
  public static function checkArray($array) {
    $valid_date = FALSE;
    $valid_time = TRUE;
    // Check for a valid date using checkdate(). Only values that
    // meet that test are valid.
    if (array_key_exists('year', $array) && array_key_exists('month', $array) && array_key_exists('day', $array)) {
      if (@checkdate($array['month'], $array['day'], $array['year'])) {
        $valid_date = TRUE;
      }
    }
    // Testing for valid time is reversed. Missing time is OK,
    // but incorrect values are not.
585
    foreach (['hour', 'minute', 'second'] as $key) {
586
587
      if (array_key_exists($key, $array)) {
        $value = $array[$key];
588
        switch ($key) {
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
          case 'hour':
            if (!preg_match('/^([1-2][0-3]|[01]?[0-9])$/', $value)) {
              $valid_time = FALSE;
            }
            break;
          case 'minute':
          case 'second':
          default:
            if (!preg_match('/^([0-5][0-9]|[0-9])$/', $value)) {
              $valid_time = FALSE;
            }
            break;
        }
      }
    }
    return $valid_date && $valid_time;
  }

  /**
   * Pads date parts with zeros.
   *
   * Helper function for a task that is often required when working with dates.
   *
   * @param int $value
   *   The value to pad.
   * @param int $size
   *   (optional) Size expected, usually 2 or 4. Defaults to 2.
   *
   * @return string
   *   The padded value.
   */
  public static function datePad($value, $size = 2) {
    return sprintf("%0" . $size . "d", $value);
  }

  /**
   * Formats the date for display.
   *
   * @param string $format
628
   *   A format string using either PHP's date().
629
630
631
632
   * @param array $settings
   *   - timezone: (optional) String timezone name. Defaults to the timezone
   *     of the date object.
   *
633
634
635
   * @return string|null
   *   The formatted value of the date or NULL if there were construction
   *   errors.
636
   */
637
  public function format($format, $settings = []) {
638
639
640
641
642
643
644
645

    // If there were construction errors, we can't format the date.
    if ($this->hasErrors()) {
      return;
    }

    // Format the date and catch errors.
    try {
646
647
648
649
650
651
652
      // Clone the date/time object so we can change the time zone without
      // disturbing the value stored in the object.
      $dateTimeObject = clone $this->dateTimeObject;
      if (isset($settings['timezone'])) {
        $dateTimeObject->setTimezone(new \DateTimeZone($settings['timezone']));
      }
      $value = $dateTimeObject->format($format);
653
654
655
656
    }
    catch (\Exception $e) {
      $this->errors[] = $e->getMessage();
    }
657

658
659
    return $value;
  }
660

661
}