Implement object value object

Author: yann-eugone

README.md

@@ -11,9 +11,6 @@ This library offer you an easy way to handle **value objects** in a **Doctrine O
 
 It will save you the creation of Doctrine types for every different value object types you have.
 
-**If you are looking for Value Objects with multiple properties to store:
-please use [Doctrine Embeddables](https://www.doctrine-project.org/projects/doctrine-orm/en/latest/tutorials/embeddables.html).**
-
 
 ## Installation
 
@@ -93,16 +90,6 @@ The object will be **stored as a string** in the database but **hydrated back to
 See [PhoneNumber code](tests/PhoneNumber.php) in tests.
 
 
-### Collection
-
-Imagine that in this application, you will sometimes have to store multiple phone numbers in a property.
-You can centralize this type hinting in a `PhoneNumbers` **collection value object**.
-
-The object will be **stored as a json** in the database but **hydrated back to this object** by Doctrine.
-
-See [PhoneNumbers code](tests/PhoneNumbers.php) in tests.
-
-
 ### DateTime
 
 Imagine you have an application that stores users birthdate.
@@ -125,6 +112,33 @@ The object will be **stored as a integer** in the database but **hydrated back t
 See [Status code](tests/Status.php) in tests.
 
 
+### Object
+
+**If you are looking for value objects with multiple properties each stored in a table column:
+please use [Doctrine Embeddables](https://www.doctrine-project.org/projects/doctrine-orm/en/latest/tutorials/embeddables.html).**
+
+**If you are looking for polymorphic value objects stored as JSON:
+please use [dunglas/doctrine-json-odm](https://github.com/dunglas/doctrine-json-odm).**
+
+Imagine you have an application that stores user notifications preferences.
+There is multiple information you want to store, as a JSON object.
+
+You can centralize this logic in a `Notifications` **object value object**.
+The object will be **stored as a json object** in the database but **hydrated back to this object** by Doctrine.
+
+See [Notifications code](tests/Notifications.php) in tests.
+
+
+### Collection
+
+Imagine that you have an application that have to store multiple phone numbers in a property.
+You can centralize this type hinting in a `PhoneNumbers` **collection value object**.
+
+The object will be **stored as a json array** in the database but **hydrated back to this object** by Doctrine.
+
+See [PhoneNumbers code](tests/PhoneNumbers.php) in tests.
+
+
 ## Contribution
 
 Please feel free to open an [issue](https://github.com/yokai-php/doctrine-value-object/issues)

src/Doctrine/Types.php

@@ -6,18 +6,15 @@
 
 use Doctrine\DBAL\Types\Type;
 use Doctrine\DBAL\Types\TypeRegistry;
-use Yokai\DoctrineValueObject\Doctrine\Types\CollectionValueObjectType;
-use Yokai\DoctrineValueObject\Doctrine\Types\DateTimeValueObjectType;
-use Yokai\DoctrineValueObject\Doctrine\Types\IntegerValueObjectType;
-use Yokai\DoctrineValueObject\Doctrine\Types\StringValueObjectType;
 
 final class Types
 {
     private const DOCTRINE_TYPES = [
-        CollectionValueObjectType::class,
-        DateTimeValueObjectType::class,
-        IntegerValueObjectType::class,
-        StringValueObjectType::class,
+        Types\CollectionValueObjectType::class,
+        Types\DateTimeValueObjectType::class,
+        Types\IntegerValueObjectType::class,
+        Types\ObjectValueObjectType::class,
+        Types\StringValueObjectType::class,
     ];
 
     private array $types;

src/Doctrine/Types/ObjectValueObjectType.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\DoctrineValueObject\Doctrine\Types;
+
+use Doctrine\DBAL\Platforms\AbstractPlatform;
+use Doctrine\DBAL\Types\JsonType;
+use Webmozart\Assert\Assert;
+use Yokai\DoctrineValueObject\ObjectValueObject;
+
+final class ObjectValueObjectType extends JsonType
+{
+    use ValueObjectType;
+
+    /**
+     * @inheritdoc
+     */
+    public static function getSupportedValueObjectType(): string
+    {
+        return ObjectValueObject::class;
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function convertToDatabaseValue($value, AbstractPlatform $platform): ?string
+    {
+        if ($value === null) {
+            return null;
+        }
+
+        Assert::isInstanceOf($value, $this->class);
+        /** @var ObjectValueObject $value */
+
+        return parent::convertToDatabaseValue($value->toValue(), $platform);
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function convertToPHPValue($value, AbstractPlatform $platform): ?ObjectValueObject
+    {
+        $value = parent::convertToPHPValue($value, $platform);
+        if ($value === null) {
+            return null;
+        }
+
+        Assert::isArray($value);
+
+        /** @var ObjectValueObject $collection */
+        $collection = \call_user_func([$this->class, 'fromValue'], $value);
+        Assert::isInstanceOf($collection, $this->class);
+
+        return $collection;
+    }
+}

src/ObjectValueObject.php

@@ -0,0 +1,15 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\DoctrineValueObject;
+
+/**
+ * todo php 8 : fromValue with static return type + impacts on descendants
+ */
+interface ObjectValueObject
+{
+    public static function fromValue(array $value): self;
+
+    public function toValue(): array;
+}

tests/EntityTest.php

@@ -19,6 +19,7 @@ final class EntityTest extends TestCase
         'birthdate' => Birthdate::class,
         'phone_number' => PhoneNumber::class,
         'phone_numbers' => PhoneNumbers::class,
+        'notifications' => Notifications::class,
     ];
 
     public function testUserWithNoValues(): void
@@ -42,6 +43,7 @@ public function testUserWithNoValues(): void
         self::assertNull($row['birthdate']);
         self::assertNull($row['contactPhoneNumber']);
         self::assertNull($row['phoneNumbers']);
+        self::assertNull($row['notifications']);
 
         // fetch entity from database
         /** @var User $user */
@@ -52,6 +54,7 @@ public function testUserWithNoValues(): void
         self::assertNull($user->birthdate);
         self::assertNull($user->contactPhoneNumber);
         self::assertNull($user->phoneNumbers);
+        self::assertNull($user->notifications);
     }
 
     public function testUserWithAllValues(): void
@@ -66,6 +69,7 @@ public function testUserWithAllValues(): void
         $user->phoneNumbers = new PhoneNumbers(
             [new PhoneNumber('+33455667788'), new PhoneNumber('+33233445566')]
         );
+        $user->notifications = new Notifications(true, false);
         // save changes
         $entityManager->persist($user);
         $entityManager->flush();
@@ -82,6 +86,7 @@ public function testUserWithAllValues(): void
         self::assertSame('1986-11-17 00:00:00', $row['birthdate']);
         self::assertSame('+33677889900', $row['contactPhoneNumber']);
         self::assertSame('["+33455667788","+33233445566"]', $row['phoneNumbers']);
+        self::assertSame('{"email":true,"sms":false}', $row['notifications']);
 
         // fetch entity from database
         /** @var User $user */
@@ -95,6 +100,8 @@ public function testUserWithAllValues(): void
             ['+33455667788', '+33233445566'],
             \array_map(fn(PhoneNumber $number) => $number->getNumber(), $user->phoneNumbers->getNumbers())
         );
+        self::assertTrue($user->notifications->isEmail());
+        self::assertFalse($user->notifications->isSms());
     }
 
     private function manager(): EntityManager

tests/Notifications.php

@@ -0,0 +1,45 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Yokai\DoctrineValueObject\Tests;
+
+use Yokai\DoctrineValueObject\ObjectValueObject;
+
+final class Notifications implements ObjectValueObject
+{
+    private bool $email;
+    private bool $sms;
+
+    public function __construct(bool $email, bool $sms)
+    {
+        $this->email = $email;
+        $this->sms = $sms;
+    }
+
+    public static function fromValue(array $value): ObjectValueObject
+    {
+        return new self(
+            $value['email'] ?? false,
+            $value['sms'] ?? false
+        );
+    }
+
+    public function toValue(): array
+    {
+        return [
+            'email' => $this->email,
+            'sms' => $this->sms,
+        ];
+    }
+
+    public function isEmail(): bool
+    {
+        return $this->email;
+    }
+
+    public function isSms(): bool
+    {
+        return $this->sms;
+    }
+}

tests/User.php

@@ -37,4 +37,9 @@ final class User
      * @ORM\Column(type="phone_numbers", nullable=true)
      */
     public ?PhoneNumbers $phoneNumbers = null;
+
+    /**
+     * @ORM\Column(type="notifications", nullable=true)
+     */
+    public ?Notifications $notifications = null;
 }