Chris@0
|
1 <?php
|
Chris@0
|
2 /*
|
Chris@14
|
3 * This file is part of sebastian/comparator.
|
Chris@0
|
4 *
|
Chris@0
|
5 * (c) Sebastian Bergmann <sebastian@phpunit.de>
|
Chris@0
|
6 *
|
Chris@0
|
7 * For the full copyright and license information, please view the LICENSE
|
Chris@0
|
8 * file that was distributed with this source code.
|
Chris@0
|
9 */
|
Chris@0
|
10
|
Chris@0
|
11 namespace SebastianBergmann\Comparator;
|
Chris@0
|
12
|
Chris@0
|
13 /**
|
Chris@0
|
14 * Compares DateTimeInterface instances for equality.
|
Chris@0
|
15 */
|
Chris@0
|
16 class DateTimeComparator extends ObjectComparator
|
Chris@0
|
17 {
|
Chris@0
|
18 /**
|
Chris@0
|
19 * Returns whether the comparator can compare two values.
|
Chris@0
|
20 *
|
Chris@14
|
21 * @param mixed $expected The first value to compare
|
Chris@14
|
22 * @param mixed $actual The second value to compare
|
Chris@14
|
23 *
|
Chris@0
|
24 * @return bool
|
Chris@0
|
25 */
|
Chris@0
|
26 public function accepts($expected, $actual)
|
Chris@0
|
27 {
|
Chris@0
|
28 return ($expected instanceof \DateTime || $expected instanceof \DateTimeInterface) &&
|
Chris@0
|
29 ($actual instanceof \DateTime || $actual instanceof \DateTimeInterface);
|
Chris@0
|
30 }
|
Chris@0
|
31
|
Chris@0
|
32 /**
|
Chris@0
|
33 * Asserts that two values are equal.
|
Chris@0
|
34 *
|
Chris@0
|
35 * @param mixed $expected First value to compare
|
Chris@0
|
36 * @param mixed $actual Second value to compare
|
Chris@0
|
37 * @param float $delta Allowed numerical distance between two values to consider them equal
|
Chris@0
|
38 * @param bool $canonicalize Arrays are sorted before comparison when set to true
|
Chris@0
|
39 * @param bool $ignoreCase Case is ignored when set to true
|
Chris@0
|
40 * @param array $processed List of already processed elements (used to prevent infinite recursion)
|
Chris@0
|
41 *
|
Chris@0
|
42 * @throws ComparisonFailure
|
Chris@0
|
43 */
|
Chris@14
|
44 public function assertEquals($expected, $actual, $delta = 0.0, $canonicalize = false, $ignoreCase = false, array &$processed = [])
|
Chris@0
|
45 {
|
Chris@14
|
46 /** @var \DateTimeInterface $expected */
|
Chris@14
|
47 /** @var \DateTimeInterface $actual */
|
Chris@14
|
48 $delta = new \DateInterval(\sprintf('PT%dS', \abs($delta)));
|
Chris@0
|
49
|
Chris@14
|
50 $actualClone = (clone $actual)
|
Chris@14
|
51 ->setTimezone(new \DateTimeZone('UTC'));
|
Chris@0
|
52
|
Chris@14
|
53 $expectedLower = (clone $expected)
|
Chris@14
|
54 ->setTimezone(new \DateTimeZone('UTC'))
|
Chris@14
|
55 ->sub($delta);
|
Chris@14
|
56
|
Chris@14
|
57 $expectedUpper = (clone $expected)
|
Chris@14
|
58 ->setTimezone(new \DateTimeZone('UTC'))
|
Chris@14
|
59 ->add($delta);
|
Chris@14
|
60
|
Chris@14
|
61 if ($actualClone < $expectedLower || $actualClone > $expectedUpper) {
|
Chris@0
|
62 throw new ComparisonFailure(
|
Chris@0
|
63 $expected,
|
Chris@0
|
64 $actual,
|
Chris@0
|
65 $this->dateTimeToString($expected),
|
Chris@0
|
66 $this->dateTimeToString($actual),
|
Chris@0
|
67 false,
|
Chris@0
|
68 'Failed asserting that two DateTime objects are equal.'
|
Chris@0
|
69 );
|
Chris@0
|
70 }
|
Chris@0
|
71 }
|
Chris@0
|
72
|
Chris@0
|
73 /**
|
Chris@0
|
74 * Returns an ISO 8601 formatted string representation of a datetime or
|
Chris@0
|
75 * 'Invalid DateTimeInterface object' if the provided DateTimeInterface was not properly
|
Chris@0
|
76 * initialized.
|
Chris@0
|
77 */
|
Chris@14
|
78 private function dateTimeToString(\DateTimeInterface $datetime): string
|
Chris@0
|
79 {
|
Chris@0
|
80 $string = $datetime->format('Y-m-d\TH:i:s.uO');
|
Chris@0
|
81
|
Chris@14
|
82 return $string ?: 'Invalid DateTimeInterface object';
|
Chris@0
|
83 }
|
Chris@0
|
84 }
|