Merge pull request #62 from nathansalter/bugfix/55-type-checks-too-strict

Reduce strictness on checks for Date/Time types

Author: nathansalter

src/Helpers/DateTime.php

@@ -22,7 +22,7 @@ public static function iso8601($date, $isDateOnly = false)
             return $date->toISO8601();
         }
 
-        if ($date instanceof \DateTime === false) {
+        if (!$date instanceof \DateTime && !$date instanceof \DateTimeImmutable) {
             throw new \Exception("Invalid argument type.");
         }
 

src/Helpers/JsonLd.php

@@ -31,13 +31,13 @@ public static function prepareDataForSerialization($obj, $parent = null, $schema
         $fq_classname = "\\".get_class($obj);
 
         // Get interval spec string, e.g. "P1D"
-        if($fq_classname === "\\DateInterval") {
+        if($obj instanceof \DateInterval) {
             return DateIntervalHelper::specString($obj);
         }
 
         // Get ISO 8601 date time representation,
         // e.g. "2019-01-01T00:00:00-08:00"
-        if($fq_classname === "\\DateTime") {
+        if($obj instanceof \DateTime || $obj instanceof \DateTimeImmutable) {
             return DateTimeHelper::iso8601($obj);
         }
 

tests/Unit/Helpers/DateIntervalExtension.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace OpenActive\Models\Tests\Unit\Helpers;
+
+class DateIntervalExtension extends \DateInterval
+{
+}

tests/Unit/Helpers/DateTimeExtension.php

@@ -0,0 +1,7 @@
+<?php
+
+namespace OpenActive\Models\Tests\Unit\Helpers;
+
+class DateTimeExtension extends \DateTime
+{
+}

tests/Unit/Helpers/JsonLdTest.php

@@ -0,0 +1,44 @@
+<?php
+
+namespace OpenActive\Models\Tests\Unit\Helpers;
+
+use OpenActive\Helpers\JsonLd;
+use PHPUnit\Framework\TestCase;
+
+class JsonLdTest extends TestCase
+{
+    /**
+     * @param $dateTime
+     * @dataProvider dateTimeProvider
+     */
+    public function testSerializesDateTimes($dateTime)
+    {
+        $this->assertEquals('2020-01-01T11:00:00+00:00', JsonLd::prepareDataForSerialization($dateTime));
+    }
+
+    /**
+     * @param $dateInterval
+     * @dataProvider dateIntervalProvider
+     */
+    public function testSerializesDateIntervals($dateInterval)
+    {
+        $this->assertEquals('P1DT1H', JsonLd::prepareDataForSerialization($dateInterval));
+    }
+
+    public function dateTimeProvider()
+    {
+        return [
+            [new \DateTime('2020-01-01T11:00:00+00:00')],
+            [new \DateTimeImmutable('2020-01-01T11:00:00+00:00')],
+            [new DateTimeExtension('2020-01-01T11:00:00+00:00')],
+        ];
+    }
+
+    public function dateIntervalProvider()
+    {
+        return [
+            [new \DateInterval('P1DT1H')],
+            [new DateIntervalExtension('P1DT1H')],
+        ];
+    }
+}