Merge pull request #70 from sasezaki/annotate_template_hydrate

Add template annotation into hydrate() method & HydrateEvent
laminas · Aug 2, 2021 · ed5d9ca · ed5d9ca
2 parents 5fe3d0e + 802eeb0
commit ed5d9ca
Show file tree

Hide file tree

Showing 4 changed files with 21 additions and 6 deletions.
diff --git a/src/Aggregate/HydrateEvent.php b/src/Aggregate/HydrateEvent.php
@@ -9,6 +9,8 @@
 /**
  * Event triggered when the {@see AggregateHydrator} hydrates
  * data into an object
+ *
+ * @template T of object
  */
 class HydrateEvent extends Event
 {
@@ -19,14 +21,18 @@ class HydrateEvent extends Event
      */
     protected $name = self::EVENT_HYDRATE;
 
-    /** @var object */
+    /**
+     * @var object
+     * @psalm-var T
+     */
     protected $hydratedObject;
 
     /** @var mixed[] Data being used to hydrate the $hydratedObject */
     protected $hydrationData;
 
     /**
      * @param mixed[] $hydrationData Data being used to hydrate the $hydratedObject
+     * @psalm-param T $hydratedObject
      */
     public function __construct(object $target, object $hydratedObject, array $hydrationData)
     {
@@ -38,12 +44,17 @@ public function __construct(object $target, object $hydratedObject, array $hydra
 
     /**
      * Retrieves the object that is being hydrated
+     *
+     * @psalm-return T
      */
     public function getHydratedObject(): object
     {
         return $this->hydratedObject;
     }
 
+    /**
+     * @psalm-param T $hydratedObject
+     */
     public function setHydratedObject(object $hydratedObject): void
     {
         $this->hydratedObject = $hydratedObject;

diff --git a/src/HydrationInterface.php b/src/HydrationInterface.php
@@ -13,6 +13,9 @@ interface HydrationInterface
      * @return object The implementation should return an object of any type.
      *     By purposely omitting the return type from the signature,
      *     implementations may choose to specify a more specific type.
+     * @psalm-param T $object
+     * @psalm-return T
+     * @template T of object
      */
     public function hydrate(array $data, object $object);
 }
diff --git a/test/Aggregate/HydratorListenerTest.php b/test/Aggregate/HydratorListenerTest.php
@@ -80,6 +80,7 @@ public function testOnHydrate(): void
             ->will($this->returnValue($hydrated));
         $event->expects($this->once())->method('setHydratedObject')->with($hydrated);
 
+        /** @psalm-suppress MixedArgumentTypeCoercion */
         $this->assertSame($hydrated, $this->listener->onHydrate($event));
     }
 

diff --git a/test/ClassMethodsHydratorTest.php b/test/ClassMethodsHydratorTest.php
@@ -46,18 +46,18 @@ public function testCanExtractFromMethodsWithOptionalParameters(): void
      */
     public function testCanHydratedPromiscuousInstances(): void
     {
-        /** @var ClassMethodsCamelCase $classMethodsCamelCase */
-        $classMethodsCamelCase = $this->hydrator->hydrate(
+        $classMethodsCamelCase        = $this->hydrator->hydrate(
             ['fooBar' => 'baz-tab'],
             new ClassMethodsCamelCase()
         );
-        /** @var ClassMethodsCamelCaseMissing $classMethodsCamelCaseMissing */
         $classMethodsCamelCaseMissing = $this->hydrator->hydrate(
             ['fooBar' => 'baz-tab'],
             new ClassMethodsCamelCaseMissing()
         );
-        /** @var ArraySerializable $arraySerializable */
-        $arraySerializable = $this->hydrator->hydrate(['fooBar' => 'baz-tab'], new ArraySerializable());
+        $arraySerializable            = $this->hydrator->hydrate(
+            ['fooBar' => 'baz-tab'],
+            new ArraySerializable()
+        );
 
         $this->assertSame('baz-tab', $classMethodsCamelCase->getFooBar());
         $this->assertSame('baz-tab', $classMethodsCamelCaseMissing->getFooBar());