Merge pull request #10 from wol-soft/PatternProperties

Pattern properties

Author: wol-soft

src/Exception/Object/InvalidPatternPropertiesException.php

@@ -0,0 +1,77 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PHPModelGenerator\Exception\Object;
+
+use PHPModelGenerator\Exception\ValidationException;
+
+/**
+ * Class InvalidPatternPropertiesException
+ *
+ * @package PHPModelGenerator\Exception\Object
+ */
+class InvalidPatternPropertiesException extends ValidationException
+{
+    /** @var ValidationException[][] */
+    protected $nestedExceptions;
+    /** @var string */
+    protected $pattern;
+
+    /**
+     * InvalidAdditionalPropertiesException constructor.
+     *
+     * @param $providedValue
+     * @param string $propertyName
+     * @param ValidationException[][] $nestedExceptions
+     */
+    public function __construct($providedValue, string $propertyName, string $pattern, $nestedExceptions)
+    {
+        $this->nestedExceptions = $nestedExceptions;
+        $this->pattern = $pattern;
+
+        parent::__construct($this->getErrorMessage($propertyName), $propertyName, $providedValue);
+    }
+
+    /**
+     * Get a list of nested exceptions containing all failed validations indexed by the required pattern
+     *
+     * @return ValidationException[][]
+     */
+    public function getNestedExceptions(): array
+    {
+        return $this->nestedExceptions;
+    }
+
+    /**
+     * @return string
+     */
+    public function getPattern(): string
+    {
+        return $this->pattern;
+    }
+
+    protected function getErrorMessage(string $propertyName): string
+    {
+        $output = '';
+        foreach ($this->nestedExceptions as $nestedPropertyName => $exceptions) {
+            $output .= sprintf(
+                "\n  - invalid property '%s' matching pattern '%s'\n    * %s",
+                $nestedPropertyName,
+                $this->pattern,
+                implode(
+                    "\n    * ",
+                    str_replace(
+                        "\n",
+                        "\n    ",
+                        array_map(function (ValidationException $exception): string {
+                            return $exception->getMessage();
+                        }, $exceptions)
+                    )
+                )
+            );
+        }
+
+        return "Provided JSON for $propertyName contains invalid pattern properties." . $output;
+    }
+}

src/Exception/Object/UnknownPatternPropertyException.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types = 1);
+
+namespace PHPModelGenerator\Exception\Object;
+
+use Exception;
+
+/**
+ * Class UnknownPatternPropertyException
+ *
+ * @package PHPModelGenerator\Exception\Object
+ */
+class UnknownPatternPropertyException extends Exception
+{
+}

src/Model/SerializedValue.php

@@ -4,8 +4,6 @@
 
 namespace PHPModelGenerator\Traits;
 
-use PHPModelGenerator\Model\SerializedValue;
-
 /**
  * Provide methods to serialize generated models
  *
@@ -68,27 +66,22 @@ public function toArray(array $except = [], int $depth = 512)
             }
 
             if ($customSerializer = $this->_getCustomSerializerMethod($key)) {
-                $this->handleSerializedValue($modelData, $key, $this->{$customSerializer}(), $depth, $except);
+                $modelData[$key] = $this->_getSerializedValue($this->{$customSerializer}(), $depth, $except);
                 continue;
             }
 
             $modelData[$key] = $this->_getSerializedValue($this->$key, $depth, $except);
         }
 
-        return $modelData;
+        return $this->resolveSerializationHook($modelData, $depth, $except);
     }
 
-    private function handleSerializedValue(array &$data, $key, $serializedValue, int $depth, array $except): void
+    /**
+     * Function can be overwritten by classes using the trait to hook into serialization
+     */
+    protected function resolveSerializationHook(array $data, int $depth, array $except): array
     {
-        if ($serializedValue instanceof SerializedValue &&
-            $serializedValue->getSerializationStrategy() === SerializedValue::STRATEGY_MERGE_VALUE
-        ) {
-            $data = array_merge($data, $this->_getSerializedValue($serializedValue->getSerializedValue(), $depth, $except));
-
-            return;
-        }
-
-        $data[$key] = $this->_getSerializedValue($serializedValue, $depth, $except);
+        return $data;
     }
 
     private function _getSerializedValue($value, int $depth, array $except) {