DateTimePlus.php 20.2 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
44
45
46
47
48
49
50
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
91
92
  /**
   * An array of possible date parts.
   */
  protected static $dateParts = array(
    'year',
    'month',
    'day',
    'hour',
    'minute',
    'second',
  );

  /**
   * 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.
   */
  protected $errors = array();

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
112
113
114
115
116
117
118
119
120
121
   */
  public static function createFromDateTime(\DateTime $datetime, $settings = array()) {
    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
133
134
   *   A new DateTimePlus object.
   *
   * @throws \Exception
   *   If the array date values or value combination is not correct.
135
136
137
138
139
   */
  public static function createFromArray(array $date_parts, $timezone = NULL, $settings = array()) {
    $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
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
      // 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 {
      throw new \Exception('The array contains invalid values.');
    }
  }

  /**
   * 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
167
168
   *
   * @return static
   *   A new DateTimePlus object.
   *
   * @throws \Exception
   *   If the timestamp is not numeric.
169
170
171
172
173
174
175
176
177
178
179
180
181
   */
  public static function createFromTimestamp($timestamp, $timezone = NULL, $settings = array()) {
    if (!is_numeric($timestamp)) {
      throw new \Exception('The timestamp must be numeric.');
    }
    $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
205
206
207
   *
   * @return static
   *   A new DateTimePlus object.
   *
   * @throws \Exception
   *   If the a date cannot be created from the given format, or if the
   *   created date does not match the input value.
208
209
210
211
212
213
214
215
216
217
218
   */
  public static function createFromFormat($format, $time, $timezone = NULL, $settings = array()) {
    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);

219
    $date = \DateTime::createFromFormat($format, $time, $datetimeplus->getTimezone());
220
    if (!$date instanceof \DateTime) {
221
222
223
      throw new \Exception('The date cannot be created from a format.');
    }
    else {
224
225
226
227
228
      // 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'.
229
      if ($date instanceof DateTimePlus) {
230
231
        $test_time = $date->format($format, $settings);
      }
232
      elseif ($date instanceof \DateTime) {
233
234
        $test_time = $date->format($format);
      }
235
236
237
      $datetimeplus->setTimestamp($date->getTimestamp());
      $datetimeplus->setTimezone($date->getTimezone());

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

  /**
   * Constructs a date object set to a requested date and timezone.
   *
   * @param string $time
249
   *   (optional) A date/time string. Defaults to 'now'.
250
   * @param mixed $timezone
251
252
   *   (optional) \DateTimeZone object, time zone string or NULL. NULL uses the
   *   default system time zone. Defaults to NULL.
253
   * @param array $settings
254
   *   (optional) Keyed array of settings. Defaults to empty array.
255
256
   *   - langcode: (optional) String two letter language code used to control
   *     the result of the format(). Defaults to NULL.
257
258
259
   *   - debug: (optional) Boolean choice to leave debug values in the
   *     date object for debugging purposes. Defaults to FALSE.
   */
260
  public function __construct($time = 'now', $timezone = NULL, $settings = array()) {
261
262
263
264
265

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

    // Massage the input values as necessary.
266
267
    $prepared_time = $this->prepareTime($time);
    $prepared_timezone = $this->prepareTimezone($timezone);
268

269
270
271
272
273
274
275
    try {
      if (!empty($prepared_time)) {
        $test = date_parse($prepared_time);
        if (!empty($test['errors'])) {
          $this->errors[] = $test['errors'];
        }
      }
276

277
      if (empty($this->errors)) {
278
        $this->dateTimeObject = new \DateTime($prepared_time, $prepared_timezone);
279
      }
280
    }
281
282
    catch (\Exception $e) {
      $this->errors[] = $e->getMessage();
283
284
285
286
287
288
289
290
    }

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

  /**
291
   * Renders the timezone name.
292
   *
293
   * @return string
294
   */
295
  public function render() {
296
    return $this->format(static::FORMAT) . ' ' . $this->getTimeZone()->getName();
297
298
  }

299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
  /**
   * 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));
    }
    return call_user_func_array(array($this->dateTimeObject, $method), $args);
  }

315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
  /**
   * Returns the difference between two DateTimePlus objects.
   *
   * @param \Drupal\Component\Datetime\DateTimePlus|\DateTime $datetime2
   *    The date to compare to.
   * @param bool $absolute
   *    Should the interval be forced to be positive?
   *
   * @return \DateInterval
   *    A DateInterval object representing the difference between the two dates.
   *
   * @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);
  }

339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
  /**
   * 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));
    }
    return call_user_func_array(array('\DateTime', $method), $args);
  }

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

360
361
362
363
364
365
366
367
368
  /**
   * 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.
369
370
371
   *
   * @return mixed
   *   The massaged time.
372
373
   */
  protected function prepareTime($time) {
374
    return $time;
375
376
377
378
379
380
  }

  /**
   * Prepares the input timezone value.
   *
   * Changes the timezone before trying to use it, if necessary.
381
   * Most importantly, makes sure there is a valid timezone
382
383
384
385
   * object before moving further.
   *
   * @param mixed $timezone
   *   Either a timezone name or a timezone object or NULL.
386
387
388
   *
   * @return \DateTimeZone
   *   The massaged time zone.
389
390
391
   */
  protected function prepareTimezone($timezone) {
    // If the input timezone is a valid timezone object, use it.
392
    if ($timezone instanceof \DateTimezone) {
393
394
395
396
397
398
399
400
401
402
      $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'.
403
    if (empty($timezone_adjusted) || !$timezone_adjusted instanceof \DateTimezone) {
404
405
406
407
408
409
      $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.
410
    return $timezone_adjusted;
411
412
413
414
415
416
417
418
419
420
  }

  /**
   * 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.
421
422
423
   *
   * @return string
   *   The massaged PHP format string.
424
425
   */
  protected function prepareFormat($format) {
426
    return $format;
427
428
429
430
431
432
433
434
435
436
437
438
  }



  /**
   * 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.
   *
439
   * @see http://php.net/manual/time.getlasterrors.php
440
441
   */
  public function checkErrors() {
442
    $errors = \DateTime::getLastErrors();
443
444
445
446
447
448
449
450
451
452
453
454
455
456
    if (!empty($errors['errors'])) {
      $this->errors += $errors['errors'];
    }
    // 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.';
    }
  }

  /**
   * Detects if there were errors in the processing of this date.
457
   *
alexpott's avatar
alexpott committed
458
   * @return bool
459
460
   *   TRUE if there were errors in the processing of this date, FALSE
   *   otherwise.
461
462
463
464
465
466
   */
  public function hasErrors() {
    return (boolean) count($this->errors);
  }

  /**
467
   * Gets error messages.
468
469
   *
   * Public function to return the error messages.
470
471
472
   *
   * @return array
   *   An array of errors encountered when creating this date.
473
474
475
476
477
478
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
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
   */
  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();
      $array += array(
        'year'   => $now->format('Y'),
        'month'  => 1,
        'day'    => 1,
        'hour'   => 0,
        'minute' => 0,
        'second' => 0,
      );
    }
    else {
      $array += array(
        'year'   => '',
        'month'  => '',
        'day'    => '',
        'hour'   => '',
        'minute' => '',
        'second' => '',
      );
    }
    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.
   *
564
   * @return bool
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
   *   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.
    foreach (array('hour', 'minute', 'second') as $key) {
      if (array_key_exists($key, $array)) {
        $value = $array[$key];
582
        switch ($key) {
583
584
585
586
587
588
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
          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
622
   *   A format string using either PHP's date().
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
   * @param array $settings
   *   - timezone: (optional) String timezone name. Defaults to the timezone
   *     of the date object.
   *
   * @return string
   *   The formatted value of the date.
   */
  public function format($format, $settings = array()) {

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

    // Format the date and catch errors.
    try {
639
640
641
642
643
644
645
      // 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);
646
647
648
649
    }
    catch (\Exception $e) {
      $this->errors[] = $e->getMessage();
    }
650

651
652
    return $value;
  }
653

654
}