Fix populating readonly properties from parent classes (#95)

CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## 1.4.1 under development
 
-- no changes in this release.
+- Bug #95: Fix populating readonly properties from parent classes (@vjik)
 
 ## 1.4.0 August 23, 2024
 

src/Hydrator.php

@@ -79,6 +79,7 @@ public function hydrate(object $object, array|DataInterface $data = []): void
 
         $this->hydrateInternal(
             $object,
+            $reflectionClass,
             ReflectionFilter::filterProperties($object, $reflectionClass),
             $data
         );
@@ -108,6 +109,7 @@ public function create(string $class, array|DataInterface $data = []): object
 
         $this->hydrateInternal(
             $object,
+            $reflectionClass,
             ReflectionFilter::filterProperties($object, $reflectionClass, $excludeProperties),
             $data
         );
@@ -120,6 +122,7 @@ public function create(string $class, array|DataInterface $data = []): object
      */
     private function hydrateInternal(
         object $object,
+        ReflectionClass $reflectionClass,
         array $reflectionProperties,
         DataInterface $data,
     ): void {
@@ -141,9 +144,25 @@ private function hydrateInternal(
                     new TypeCastContext($this, $property),
                 );
                 if ($result->isResolved()) {
-                    $property->setValue($object, $result->getValue());
+                    $this
+                        ->preparePropertyToSetValue($reflectionClass, $property, $propertyName)
+                        ->setValue($object, $result->getValue());
                 }
             }
         }
     }
+
+    private function preparePropertyToSetValue(
+        ReflectionClass $class,
+        ReflectionProperty $property,
+        string $propertyName,
+    ): ReflectionProperty {
+        if ($property->isReadOnly()) {
+            $declaringClass = $property->getDeclaringClass();
+            if ($declaringClass !== $class) {
+                return $declaringClass->getProperty($propertyName);
+            }
+        }
+        return $property;
+    }
 }

tests/HydratorTest.php

@@ -30,6 +30,8 @@
 use Yiisoft\Hydrator\Tests\Support\Classes\ConstructorTypeClass;
 use Yiisoft\Hydrator\Tests\Support\Classes\CounterClass;
 use Yiisoft\Hydrator\Tests\Support\Classes\FromPredefinedArrayClass;
+use Yiisoft\Hydrator\Tests\Support\Classes\Inheritance\ReadOnly\ImageSlideDto;
+use Yiisoft\Hydrator\Tests\Support\Classes\Inheritance\Figure\Circle;
 use Yiisoft\Hydrator\Tests\Support\Classes\InvalidDataResolverClass;
 use Yiisoft\Hydrator\Tests\Support\Classes\NestedModel\UserModel;
 use Yiisoft\Hydrator\Tests\Support\Classes\NonInitializedReadonlyProperties;
@@ -769,4 +771,42 @@ public function testHydrateNonInitializedReadonlyProperties(): void
         $this->assertSame('1', $object->a);
         $this->assertSame('3', $object->b);
     }
+
+    public function testBaseInheritance(): void
+    {
+        $hydrator = new Hydrator();
+
+        $object = $hydrator->create(
+            Circle::class,
+            [
+                'name' => 'Wheel',
+                'color' => 'Red',
+                'id' => 'x7',
+                'radius' => 17,
+            ]
+        );
+
+        $this->assertSame(17, $object->radius);
+        $this->assertSame('Wheel', $object->name);
+        $this->assertSame('Red', $object->getColor());
+        $this->assertNull($object->getId());
+    }
+
+    public function testReadOnlyInheritance(): void
+    {
+        $hydrator = new Hydrator();
+
+        $object = $hydrator->create(
+            ImageSlideDto::class,
+            [
+                'src' => '/images/slide.jpg',
+                'width' => 200,
+                'height' => 300,
+            ]
+        );
+
+        $this->assertSame('/images/slide.jpg', $object->src);
+        $this->assertSame(200, $object->width);
+        $this->assertSame(300, $object->height);
+    }
 }

tests/Support/Classes/Inheritance/Figure/Circle.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Hydrator\Tests\Support\Classes\Inheritance\Figure;
+
+final class Circle extends Figure
+{
+    public ?int $radius = null;
+}

tests/Support/Classes/Inheritance/Figure/Figure.php

@@ -0,0 +1,22 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Hydrator\Tests\Support\Classes\Inheritance\Figure;
+
+class Figure
+{
+    public ?string $name = null;
+    protected ?string $color = null;
+    private ?int $id = null;
+
+    public function getColor(): ?string
+    {
+        return $this->color;
+    }
+
+    public function getId(): ?int
+    {
+        return $this->id;
+    }
+}

tests/Support/Classes/Inheritance/ReadOnly/ImageSlideDto.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Hydrator\Tests\Support\Classes\Inheritance\ReadOnly;
+
+final class ImageSlideDto extends SlideDto
+{
+    public readonly string $src;
+}

tests/Support/Classes/Inheritance/ReadOnly/SlideDto.php

@@ -0,0 +1,11 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yiisoft\Hydrator\Tests\Support\Classes\Inheritance\ReadOnly;
+
+class SlideDto
+{
+    public readonly ?int $width;
+    public readonly ?int $height;
+}