Merge pull request #13 from sunrise-php/release/v2.2.0

v2.2.0
sunrise-php · Jan 10, 2022 · 973bee7 · 973bee7
2 parents a361c49 + 468710e
commit 973bee7
Show file tree

Hide file tree

Showing 4 changed files with 88 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -53,6 +53,8 @@ final class Foo
     private Bar $bar; // see bellow...
     private BarCollection $barCollection; // see bellow...
 
+    private DateInterval $duration; // see ISO 8601, e.g. "P3Y6M4DT12H30M5S"
+
     /**
      * @Alias("non-normalized")
      */

diff --git a/src/Hydrator.php b/src/Hydrator.php
@@ -70,6 +70,7 @@ class Hydrator implements HydratorInterface
         'object' => 'hydratePropertyWithObject',
         'DateTime' => 'hydratePropertyWithTimestamp',
         'DateTimeImmutable' => 'hydratePropertyWithTimestamp',
+        'DateInterval' => 'hydratePropertyWithInterval',
     ];
 
     /**
@@ -585,6 +586,50 @@ private function hydratePropertyWithTimestamp(
         ));
     }
 
+    /**
+     * Hydrates the given property with the given interval
+     *
+     * @param object $object
+     * @param ReflectionClass $class
+     * @param ReflectionProperty $property
+     * @param ReflectionNamedType $type
+     * @param mixed $value
+     *
+     * @return void
+     *
+     * @throws Exception\InvalidValueException
+     *         If the given value isn't valid.
+     */
+    private function hydratePropertyWithInterval(
+        object $object,
+        ReflectionClass $class,
+        ReflectionProperty $property,
+        ReflectionNamedType $type,
+        $value
+    ) : void {
+        if (!is_string($value)) {
+            throw new Exception\InvalidValueException($property, sprintf(
+                'The %s.%s property accepts a string only.',
+                $class->getShortName(),
+                $property->getName()
+            ));
+        }
+
+        $prototype = $type->getName();
+
+        try {
+            $interval = new $prototype($value);
+        } catch (\Exception $e) {
+            throw new Exception\InvalidValueException($property, sprintf(
+                'The %s.%s property accepts a valid interval based on ISO 8601.',
+                $class->getShortName(),
+                $property->getName()
+            ));
+        }
+
+        $property->setValue($object, $interval);
+    }
+
     /**
      * Hydrates the given property with the given many associations
      *

diff --git a/tests/HydratorTest.php b/tests/HydratorTest.php
@@ -318,4 +318,33 @@ public function testHydratePropertyWithInvalidOneOfAssociations() : void
             'value' => [0],
         ]);
     }
+
+    public function testHydratePropertyWithInterval() : void
+    {
+        $object = (new Hydrator)->hydrate(Fixtures\Baz::class, [
+            'duration' => 'P1W2D',
+        ]);
+
+        $this->assertInstanceOf(\DateInterval::class, $object->duration);
+    }
+
+    public function testHydratePropertyWithInvalidIntervalType() : void
+    {
+        $this->expectException(Exception\InvalidValueException::class);
+        $this->expectExceptionMessage('The Baz.duration property accepts a string only.');
+
+        (new Hydrator)->hydrate(Fixtures\Baz::class, [
+            'duration' => 0,
+        ]);
+    }
+
+    public function testHydratePropertyWithInvalidInterval() : void
+    {
+        $this->expectException(Exception\InvalidValueException::class);
+        $this->expectExceptionMessage('The Baz.duration property accepts a valid interval based on ISO 8601.');
+
+        (new Hydrator)->hydrate(Fixtures\Baz::class, [
+            'duration' => 'fuuu',
+        ]);
+    }
 }
diff --git a/tests/fixtures/Baz.php b/tests/fixtures/Baz.php
@@ -0,0 +1,12 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Sunrise\Hydrator\Tests\Fixtures;
+
+use DateInterval;
+
+final class Baz
+{
+    public DateInterval $duration;
+}