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

namespace Drupal\Component\Datetime;
4

5
use Drupal\Component\Utility\ToStringTrait;
6 7

/**
8
 * Wraps DateTime().
9
 *
10
 * This class wraps the PHP DateTime class with more flexible initialization
11 12 13 14 15
 * 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.
 *
16
 * This class is less lenient than the DateTime class. It changes
17
 * the default behavior for handling date values like '2011-00-00'.
18
 * The DateTime class would convert that value to '2010-11-30' and report
19 20
 * a warning but not an error. This extension treats that as an error.
 *
21
 * As with the DateTime class, a date object may be created even if it has
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 27 28 29 30 31 32 33 34 35 36 37 38
 *
 * @method $this add(\DateInterval $interval)
 * @method static array getLastErrors()
 * @method $this modify(string $modify)
 * @method $this setDate(int $year, int $month, int $day)
 * @method $this setISODate(int $year, int $week, int $day = 1)
 * @method $this setTime(int $hour, int $minute, int $second = 0, int $microseconds = 0)
 * @method $this setTimestamp(int $unixtimestamp)
 * @method $this setTimezone(\DateTimeZone $timezone)
 * @method $this sub(\DateInterval $interval)
 * @method int getOffset()
 * @method int getTimestamp()
 * @method \DateTimeZone getTimezone()
39
 */
40
class DateTimePlus {
41

42 43
  use ToStringTrait;

44
  const FORMAT = 'Y-m-d H:i:s';
45

46 47 48
  /**
   * A RFC7231 Compliant date.
   *
49
   * @see http://tools.ietf.org/html/rfc7231#section-7.1.1.1
50 51 52 53 54
   *
   * Example: Sun, 06 Nov 1994 08:49:37 GMT
   */
  const RFC7231 = 'D, d M Y H:i:s \G\M\T';

55 56 57
  /**
   * An array of possible date parts.
   */
58
  protected static $dateParts = [
59 60 61 62 63 64
    'year',
    'month',
    'day',
    'hour',
    'minute',
    'second',
65
  ];
66 67 68

  /**
   * The value of the time value passed to the constructor.
69 70
   *
   * @var string
71 72 73 74 75
   */
  protected $inputTimeRaw = '';

  /**
   * The prepared time, without timezone, for this date.
76 77
   *
   * @var string
78 79 80 81 82
   */
  protected $inputTimeAdjusted = '';

  /**
   * The value of the timezone passed to the constructor.
83 84
   *
   * @var string
85 86 87 88 89
   */
  protected $inputTimeZoneRaw = '';

  /**
   * The prepared timezone object used to construct this date.
90 91
   *
   * @var string
92 93 94 95 96
   */
  protected $inputTimeZoneAdjusted = '';

  /**
   * The value of the format passed to the constructor.
97 98
   *
   * @var string
99 100 101 102 103
   */
  protected $inputFormatRaw = '';

  /**
   * The prepared format, if provided.
104 105
   *
   * @var string
106 107 108 109 110 111 112 113 114 115 116
   */
  protected $inputFormatAdjusted = '';

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

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

119 120 121 122 123 124 125
  /**
   * The DateTime object.
   *
   * @var \DateTime
   */
  protected $dateTimeObject = NULL;

126 127
  /**
   * Creates a date object from an input date object.
128
   *
129 130 131
   * @param \DateTime $datetime
   *   A DateTime object.
   * @param array $settings
132 133
   *   (optional) A keyed array for settings, suitable for passing on to
   *   __construct().
134 135 136
   *
   * @return static
   *   A new DateTimePlus object.
137
   */
138
  public static function createFromDateTime(\DateTime $datetime, $settings = []) {
139 140 141 142 143 144 145 146 147 148
    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
149
   *   An array of date parts, like ('year' => 2014, 'month' => 4).
150
   * @param mixed $timezone
151 152
   *   (optional) \DateTimeZone object, time zone string or NULL. NULL uses the
   *   default system time zone. Defaults to NULL.
153
   * @param array $settings
154 155 156 157
   *   (optional) A keyed array for settings, suitable for passing on to
   *   __construct().
   *
   * @return static
158 159
   *   A new DateTimePlus object.
   *
160
   * @throws \InvalidArgumentException
161
   *   If the array date values or value combination is not correct.
162
   */
163
  public static function createFromArray(array $date_parts, $timezone = NULL, $settings = []) {
164 165 166
    $date_parts = static::prepareArray($date_parts, TRUE);
    if (static::checkArray($date_parts)) {
      // Even with validation, we can end up with a value that the
167
      // DateTime class won't handle, like a year outside the range
168 169 170 171 172 173
      // 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 {
174
      throw new \InvalidArgumentException('The array contains invalid values.');
175 176 177 178 179 180 181 182 183 184 185 186
    }
  }

  /**
   * 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
187 188
   *   (optional) \DateTimeZone object, time zone string or NULL. See
   *   __construct() for more details.
189
   * @param array $settings
190 191
   *   (optional) A keyed array for settings, suitable for passing on to
   *   __construct().
192 193 194 195
   *
   * @return static
   *   A new DateTimePlus object.
   *
196
   * @throws \InvalidArgumentException
197
   *   If the timestamp is not numeric.
198
   */
199
  public static function createFromTimestamp($timestamp, $timezone = NULL, $settings = []) {
200
    if (!is_numeric($timestamp)) {
201
      throw new \InvalidArgumentException('The timestamp must be numeric.');
202 203 204 205 206 207 208 209 210
    }
    $datetime = new static('', $timezone, $settings);
    $datetime->setTimestamp($timestamp);
    return $datetime;
  }

  /**
   * Creates a date object from an input format.
   *
211 212
   * @param string $format
   *   PHP date() type format for parsing the input. This is recommended
213 214
   *   to use things like negative years, which php's parser fails on, or
   *   any other specialized input with a known format. If provided the
215
   *   date will be created using the createFromFormat() method.
216
   *   @see http://php.net/manual/datetime.createfromformat.php
217 218
   * @param string $time
   *   String representing the time.
219
   * @param mixed $timezone
220 221
   *   (optional) \DateTimeZone object, time zone string or NULL. See
   *   __construct() for more details.
222
   * @param array $settings
223 224
   *   (optional) A keyed array for settings, suitable for passing on to
   *   __construct(). Supports an additional key:
225 226 227 228 229 230 231
   *   - 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.
232 233 234 235
   *
   * @return static
   *   A new DateTimePlus object.
   *
236 237 238 239
   * @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.
240
   */
241
  public static function createFromFormat($format, $time, $timezone = NULL, $settings = []) {
242 243 244 245 246 247 248 249 250
    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);

251
    $date = \DateTime::createFromFormat($format, $time, $datetimeplus->getTimezone());
252
    if (!$date instanceof \DateTime) {
253
      throw new \InvalidArgumentException('The date cannot be created from a format.');
254 255
    }
    else {
256 257 258 259 260
      // 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'.
261
      if ($date instanceof DateTimePlus) {
262 263
        $test_time = $date->format($format, $settings);
      }
264
      elseif ($date instanceof \DateTime) {
265 266
        $test_time = $date->format($format);
      }
267 268 269
      $datetimeplus->setTimestamp($date->getTimestamp());
      $datetimeplus->setTimezone($date->getTimezone());

270
      if ($settings['validate_format'] && $test_time != $time) {
271
        throw new \UnexpectedValueException('The created date does not match the input value.');
272 273 274 275 276 277 278 279 280
      }
    }
    return $datetimeplus;
  }

  /**
   * Constructs a date object set to a requested date and timezone.
   *
   * @param string $time
281
   *   (optional) A date/time string. Defaults to 'now'.
282
   * @param mixed $timezone
283
   *   (optional) \DateTimeZone object, time zone string or NULL. NULL uses the
284 285 286 287
   *   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).
288
   *   @see http://php.net/manual/datetime.construct.php
289
   * @param array $settings
290
   *   (optional) Keyed array of settings. Defaults to empty array.
291 292
   *   - langcode: (optional) String two letter language code used to control
   *     the result of the format(). Defaults to NULL.
293 294 295
   *   - debug: (optional) Boolean choice to leave debug values in the
   *     date object for debugging purposes. Defaults to FALSE.
   */
296
  public function __construct($time = 'now', $timezone = NULL, $settings = []) {
297 298 299 300 301

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

    // Massage the input values as necessary.
302 303
    $prepared_time = $this->prepareTime($time);
    $prepared_timezone = $this->prepareTimezone($timezone);
304

305
    try {
306
      $this->errors = [];
307 308 309
      if (!empty($prepared_time)) {
        $test = date_parse($prepared_time);
        if (!empty($test['errors'])) {
310
          $this->errors = $test['errors'];
311 312
        }
      }
313

314
      if (empty($this->errors)) {
315
        $this->dateTimeObject = new \DateTime($prepared_time, $prepared_timezone);
316
      }
317
    }
318 319
    catch (\Exception $e) {
      $this->errors[] = $e->getMessage();
320 321 322 323 324 325 326
    }

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

  /**
327
   * Renders the timezone name.
328
   *
329
   * @return string
330
   */
331
  public function render() {
332
    return $this->format(static::FORMAT) . ' ' . $this->getTimeZone()->getName();
333 334
  }

335 336 337 338
  /**
   * Implements the magic __call method.
   *
   * Passes through all unknown calls onto the DateTime object.
339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355
   *
   * @param string $method
   *   The method to call on the decorated object.
   * @param array $args
   *   Call arguments.
   *
   * @return mixed
   *   The return value from the method on the decorated object. If the proxied
   *   method call returns a DateTime object, then return the original
   *   DateTimePlus object, which allows function chaining to work properly.
   *   Otherwise, the value from the proxied method call is returned.
   *
   * @throws \Exception
   *   Thrown when the DateTime object is not set.
   * @throws \BadMethodCallException
   *   Thrown when there is no corresponding method on the DateTime object to
   *   call.
356
   */
357
  public function __call($method, array $args) {
358 359 360 361 362 363 364
    // @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));
    }
365 366 367 368

    $result = call_user_func_array([$this->dateTimeObject, $method], $args);

    return $result === $this->dateTimeObject ? $this : $result;
369 370
  }

371 372 373 374
  /**
   * Returns the difference between two DateTimePlus objects.
   *
   * @param \Drupal\Component\Datetime\DateTimePlus|\DateTime $datetime2
375
   *   The date to compare to.
376
   * @param bool $absolute
377
   *   Should the interval be forced to be positive?
378 379
   *
   * @return \DateInterval
380
   *   A DateInterval object representing the difference between the two dates.
381 382 383 384 385 386 387 388 389 390 391 392 393 394
   *
   * @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);
  }

395 396 397 398 399 400 401 402 403
  /**
   * 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));
    }
404
    return call_user_func_array(['\DateTime', $method], $args);
405 406 407 408 409 410 411 412 413 414 415
  }

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

416 417 418 419 420 421 422 423 424
  /**
   * 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.
425 426 427
   *
   * @return mixed
   *   The massaged time.
428 429
   */
  protected function prepareTime($time) {
430
    return $time;
431 432 433 434 435 436
  }

  /**
   * Prepares the input timezone value.
   *
   * Changes the timezone before trying to use it, if necessary.
437
   * Most importantly, makes sure there is a valid timezone
438 439 440 441
   * object before moving further.
   *
   * @param mixed $timezone
   *   Either a timezone name or a timezone object or NULL.
442 443 444
   *
   * @return \DateTimeZone
   *   The massaged time zone.
445 446 447
   */
  protected function prepareTimezone($timezone) {
    // If the input timezone is a valid timezone object, use it.
448
    if ($timezone instanceof \DateTimezone) {
449 450 451 452 453 454 455 456 457 458
      $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'.
459
    if (empty($timezone_adjusted) || !$timezone_adjusted instanceof \DateTimezone) {
460 461 462 463 464 465
      $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.
466
    return $timezone_adjusted;
467 468 469 470 471 472 473 474 475 476
  }

  /**
   * 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.
477 478 479
   *
   * @return string
   *   The massaged PHP format string.
480 481
   */
  protected function prepareFormat($format) {
482
    return $format;
483 484 485 486 487 488 489 490 491 492
  }

  /**
   * 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.
   *
493
   * @see http://php.net/manual/time.getlasterrors.php
494 495
   */
  public function checkErrors() {
496
    $errors = \DateTime::getLastErrors();
497
    if (!empty($errors['errors'])) {
498
      $this->errors = array_merge($this->errors, $errors['errors']);
499 500 501 502 503 504 505 506
    }
    // 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.';
    }
507 508

    $this->errors = array_values(array_unique($this->errors));
509 510 511 512
  }

  /**
   * Detects if there were errors in the processing of this date.
513
   *
alexpott's avatar
alexpott committed
514
   * @return bool
515 516
   *   TRUE if there were errors in the processing of this date, FALSE
   *   otherwise.
517 518 519 520 521 522
   */
  public function hasErrors() {
    return (boolean) count($this->errors);
  }

  /**
523
   * Gets error messages.
524 525
   *
   * Public function to return the error messages.
526 527 528
   *
   * @return array
   *   An array of errors encountered when creating this date.
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 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586
   */
  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();
587
      $array += [
588 589 590 591 592 593
        'year'   => $now->format('Y'),
        'month'  => 1,
        'day'    => 1,
        'hour'   => 0,
        'minute' => 0,
        'second' => 0,
594
      ];
595 596
    }
    else {
597
      $array += [
598 599 600 601 602 603
        'year'   => '',
        'month'  => '',
        'day'    => '',
        'hour'   => '',
        'minute' => '',
        'second' => '',
604
      ];
605 606 607 608 609 610 611 612 613 614 615 616 617 618 619
    }
    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.
   *
620
   * @return bool
621 622 623 624 625 626
   *   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
627 628 629 630
    // meet that test are valid. An empty value, either a string or a 0, is not
    // a valid value.
    if (!empty($array['year']) && !empty($array['month']) && !empty($array['day'])) {
      $valid_date = checkdate($array['month'], $array['day'], $array['year']);
631 632 633
    }
    // Testing for valid time is reversed. Missing time is OK,
    // but incorrect values are not.
634
    foreach (['hour', 'minute', 'second'] as $key) {
635 636
      if (array_key_exists($key, $array)) {
        $value = $array[$key];
637
        switch ($key) {
638 639 640 641 642
          case 'hour':
            if (!preg_match('/^([1-2][0-3]|[01]?[0-9])$/', $value)) {
              $valid_time = FALSE;
            }
            break;
643

644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677
          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
678
   *   Format accepted by date().
679 680 681 682
   * @param array $settings
   *   - timezone: (optional) String timezone name. Defaults to the timezone
   *     of the date object.
   *
683 684 685
   * @return string|null
   *   The formatted value of the date or NULL if there were construction
   *   errors.
686
   */
687
  public function format($format, $settings = []) {
688 689 690 691 692 693 694 695

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

    // Format the date and catch errors.
    try {
696 697 698 699 700 701 702
      // 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);
703 704 705 706
    }
    catch (\Exception $e) {
      $this->errors[] = $e->getMessage();
    }
707

708 709
    return $value;
  }
710

711 712 713 714 715 716 717 718 719 720 721
  /**
   * Sets the default time for an object built from date-only data.
   *
   * The default time for a date without time can be anything, so long as it is
   * consistently applied. If we use noon, dates in most timezones will have the
   * same value for in both the local timezone and UTC.
   */
  public function setDefaultDateTime() {
    $this->dateTimeObject->setTime(12, 0, 0);
  }

722 723 724 725 726 727 728 729 730 731
  /**
   * Gets a clone of the proxied PHP \DateTime object wrapped by this class.
   *
   * @return \DateTime
   *   A clone of the wrapped PHP \DateTime object.
   */
  public function getPhpDateTime() {
    return clone $this->dateTimeObject;
  }

732
}