Extend serialization to provide a merge strategy for a custom serialization (#6)

Author: wol-soft

src/Exception/Object/InvalidAdditionalPropertiesException.php

@@ -35,7 +35,7 @@ public function __construct($providedValue, string $propertyName, $nestedExcepti
 
     /**
      * Get a list of nested exceptions containing all failed validations indexed by the property name
-
+     *
      * @return ValidationException[][]
      */
     public function getNestedExceptions(): array

src/Exception/Object/RegularPropertyAsAdditionalPropertyException.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PHPModelGenerator\Exception\Object;
+
+use PHPModelGenerator\Exception\ValidationException;
+
+/**
+ * Class RegularPropertyAsAdditionalPropertyException
+ *
+ * @package PHPModelGenerator\Exception\Object
+ */
+class RegularPropertyAsAdditionalPropertyException extends ValidationException
+{
+    /**
+     * @var string
+     */
+    private $class;
+
+    /**
+     * EnumException constructor.
+     *
+     * @param $providedValue
+     * @param string $propertyName
+     * @param string $class
+     */
+    public function __construct($providedValue, string $propertyName, string $class)
+    {
+        $this->class = $class;
+
+        parent::__construct(
+            sprintf("Couldn't add regular property %s as additional property to object %s", $propertyName, $class),
+            $propertyName,
+            $providedValue
+        );
+    }
+
+    /**
+     * @return string
+     */
+    public function getClass(): string
+    {
+        return $this->class;
+    }
+}

src/Model/SerializedValue.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PHPModelGenerator\Model;
+
+use Exception;
+
+class SerializedValue
+{
+    // simply add the provided value under the property key
+    public const STRATEGY_ADD_VALUE = 0;
+    // merge the provided value into the serialization result
+    public const STRATEGY_MERGE_VALUE = 1;
+
+    /** @var mixed */
+    protected $serializedValue;
+    /** @var int */
+    protected $serializationStrategy;
+
+    public function __construct($serializedValue, int $serializationStrategy = self::STRATEGY_ADD_VALUE)
+    {
+        if (!is_array($serializedValue) && $serializationStrategy === self::STRATEGY_MERGE_VALUE) {
+            throw new Exception("Can't merge a non-array value into serialization result");
+        }
+
+        $this->serializedValue = $serializedValue;
+        $this->serializationStrategy = $serializationStrategy;
+    }
+
+    /**
+     * @return mixed
+     */
+    public function getSerializedValue()
+    {
+        return $this->serializedValue;
+    }
+
+    /**
+     * @return int
+     */
+    public function getSerializationStrategy(): int
+    {
+        return $this->serializationStrategy;
+    }
+}

src/Traits/SerializableTrait.php

@@ -4,6 +4,8 @@
 
 namespace PHPModelGenerator\Traits;
 
+use PHPModelGenerator\Model\SerializedValue;
+
 /**
  * Provide methods to serialize generated models
  *
@@ -13,6 +15,8 @@
  */
 trait SerializableTrait
 {
+    private static $customSerializer = [];
+
     /**
      * Get a JSON representation of the current state
      *
@@ -32,6 +36,14 @@ public function toJSON(array $except = [], int $options = 0, int $depth = 512)
         return json_encode($this->toArray($except, $depth), $options, $depth);
     }
 
+    /**
+     * Return a JSON serializable representation of the current state
+     */
+    public function jsonSerialize()
+    {
+        return $this->toArray();
+    }
+
     /**
      * Get an array representation of the current state
      *
@@ -56,27 +68,40 @@ public function toArray(array $except = [], int $depth = 512)
                 continue;
             }
 
+            if ($customSerializer = $this->getCustomSerializerMethod($key)) {
+                $this->handleSerializedValue($modelData, $key, $this->{$customSerializer}());
+                continue;
+            }
+
             if (is_array($value)) {
                 $subData = [];
                 foreach ($value as $subKey => $element) {
-                    $subData[$subKey] = $this->evaluateAttribute($key, $element, $depth, $except);
+                    $subData[$subKey] = $this->evaluateAttribute($element, $depth, $except);
                 }
                 $modelData[$key] = $subData;
             } else {
-                $modelData[$key] = $this->evaluateAttribute($key, $value, $depth, $except);
+                $modelData[$key] = $this->evaluateAttribute($value, $depth, $except);
             }
         }
 
         return $modelData;
     }
 
-    private function evaluateAttribute(string $property, $attribute, int $depth, array $except)
+    private function handleSerializedValue(array &$data, $key, $serializedValue): void
     {
-        $customSerializer = 'serialize' . ucfirst($property);
-        if (method_exists($this, $customSerializer)) {
-            return $this->{$customSerializer}();
+        if ($serializedValue instanceof SerializedValue &&
+            $serializedValue->getSerializationStrategy() === SerializedValue::STRATEGY_MERGE_VALUE
+        ) {
+            $data = array_merge($data, $serializedValue->getSerializedValue());
+
+            return;
         }
 
+        $data[$key] = $serializedValue;
+    }
+
+    private function evaluateAttribute($attribute, int $depth, array $except)
+    {
         if (!is_object($attribute)) {
             return $attribute;
         }
@@ -88,17 +113,22 @@ private function evaluateAttribute(string $property, $attribute, int $depth, arr
         return (0 >= $depth)
             ? null
             : (
-            method_exists($attribute, 'toArray')
-                ? $attribute->toArray($except, $depth - 1)
-                : get_object_vars($attribute)
+                method_exists($attribute, 'toArray')
+                    ? $attribute->toArray($except, $depth - 1)
+                    : get_object_vars($attribute)
             );
     }
 
-    /**
-     * Return a JSON serializable representation of the current state
-     */
-    public function jsonSerialize()
-    {
-        return $this->toArray();
+    private function getCustomSerializerMethod(string $property) {
+        if (isset(self::$customSerializer[$property])) {
+            return self::$customSerializer[$property];
+        }
+
+        $customSerializer = 'serialize' . ucfirst($property);
+        if (!method_exists($this, $customSerializer)) {
+            $customSerializer = false;
+        }
+
+        return self::$customSerializer[$property] = $customSerializer;
     }
 }