Added optional serialization functions

Author: wol-soft

README.md

@@ -71,6 +71,7 @@ Method | Configuration | Default
 ``` setImmutable(bool $immutable) ``` <br><br>Example:<br> ``` setImmutable(false) ``` | If set to true the generated model classes will be delivered without setter methods for the object properties. | true
 ``` setCollectErrors(bool $collectErrors) ``` <br><br>Example:<br> ``` setCollectErrors(false) ``` | By default the complete input is validated and in case of failing validations all error messages will be thrown in a single exception. If set to false the first failing validation will throw an exception. | true
 ``` setPrettyPrint(bool $prettyPrint) ``` <br><br>Example:<br> ``` setPrettyPrint(false) ``` | If set to false, the generated model classes won't follow coding gudelines (but the generation is faster). If enabled the package [Symplify/EasyCodingStandard](https://github.com/Symplify/EasyCodingStandard) will be used to clean up the generated code. | true
+``` setSerialization(bool $serialization) ``` <br><br>Example:<br> ``` setSerialization(true) ``` | If set to true the serialization methods `toArray` and `toJSON` will be added to the public interface of the generated classes. | false
 ``` setOutputEnabled(bool $prettyPrint) ``` <br><br>Example:<br> ``` setOutputEnabled(false) ``` | Enable or disable output of the generation process to STDOUT | true
 ``` setErrorRegistryClass(string $exceptionClass) ``` <br><br>Example:<br> ``` setErrorRegistryClass(CustomException::class) ``` | Define a custom exception implementing the ErrorRegistryExceptionInterface to decouple the generated code from the library (if you want to declare the library as a dev-dependency). The exception will be thrown if a validation fails error collection is **enabled** | ErrorRegistryException::class
 ``` setExceptionClass(bool $prettyPrint) ``` <br><br>Example:<br> ``` setExceptionClass(CustomException::class) ``` | Define a custom exception to decouple the generated code from the library (if you want to declare the library as a dev-dependency). The exception will be thrown if a validation fails error collection is **disabled** | ValidationException::class

src/Model/GeneratorConfiguration.php

@@ -28,6 +28,8 @@ class GeneratorConfiguration
     protected $errorRegistryClass = ErrorRegistryException::class;
     /** @var string */
     protected $exceptionClass = ValidationException::class;
+    /** @var bool */
+    protected $serialization = false;
 
     /**
      * @return string
@@ -45,6 +47,7 @@ public function getNamespacePrefix(): string
     public function setNamespacePrefix(string $namespacePrefix): self
     {
         $this->namespacePrefix = $namespacePrefix;
+
         return $this;
     }
 
@@ -64,6 +67,7 @@ public function isImmutable(): bool
     public function setImmutable(bool $immutable): self
     {
         $this->immutable = $immutable;
+
         return $this;
     }
 
@@ -83,6 +87,27 @@ public function hasPrettyPrintEnabled(): bool
     public function setPrettyPrint(bool $prettyPrint): self
     {
         $this->prettyPrint = $prettyPrint;
+
+        return $this;
+    }
+
+    /**
+     * @return bool
+     */
+    public function hasSerializationEnabled(): bool
+    {
+        return $this->serialization;
+    }
+
+    /**
+     * @param bool $serialization
+     *
+     * @return $this
+     */
+    public function setSerialization(bool $serialization): self
+    {
+        $this->serialization = $serialization;
+
         return $this;
     }
 
@@ -94,6 +119,7 @@ public function setPrettyPrint(bool $prettyPrint): self
     public function setOutputEnabled(bool $outputEnabled): self
     {
         $this->outputEnabled = $outputEnabled;
+
         return $this;
     }
 
@@ -121,6 +147,7 @@ public function collectErrors(): bool
     public function setCollectErrors(bool $collectErrors): self
     {
         $this->collectErrors = $collectErrors;
+
         return $this;
     }
 
@@ -140,6 +167,7 @@ public function getErrorRegistryClass(): string
     public function setErrorRegistryClass(string $errorRegistryClass): self
     {
         $this->errorRegistryClass = $errorRegistryClass;
+
         return $this;
     }
 
@@ -159,6 +187,7 @@ public function getExceptionClass(): string
     public function setExceptionClass(string $exceptionClass): self
     {
         $this->exceptionClass = $exceptionClass;
+
         return $this;
     }
 }

src/Templates/Model.phptpl

@@ -167,4 +167,32 @@ class {{ class }}
             return $value;
         }
     {% endforeach %}
+
+    {% if generatorConfiguration.hasSerializationEnabled() %}
+        /**
+         * Get an array representation of the current state
+         *
+         * @return array
+         */
+        public function toArray(): array
+        {
+            $modelData = get_object_vars($this);
+
+            unset($modelData['rawModelDataInput'], $modelData['errorRegistry'], $modelData['isInitialClass']);
+
+            return $modelData;
+        }
+
+        /**
+         * Get a JSON representation of the current state
+         *
+         * @param int $options [optional] Bitmask for json_encode
+         *
+         * @return string
+         */
+        public function toJSON(int $options = 0): string
+        {
+            return json_encode($this->toArray(), $options);
+        }
+    {% endif %}
 }

tests/Basic/BasicSchemaGenerationTest.php

@@ -67,6 +67,29 @@ public function testSetterChangeTheInternalState(): void
         $this->assertSame('NewValue', $object->getProperty());
     }
 
+    public function testSerializationFunctionsAreNotGeneratedByDefault(): void
+    {
+        $className = $this->generateClassFromFile('BasicSchema.json');
+
+        $object = new $className(['property' => 'Hello']);
+
+        $this->assertFalse(is_callable([$object, 'toArray']));
+        $this->assertFalse(is_callable([$object, 'toJSON']));
+    }
+
+    public function testSerializationFunctionsAreGeneratedWithEnabledSerialization(): void
+    {
+        $className = $this->generateClassFromFile(
+            'BasicSchema.json',
+            (new GeneratorConfiguration())->setSerialization(true)
+        );
+
+        $object = new $className(['property' => 'Hello']);
+
+        $this->assertEquals(['property' => 'Hello'], $object->toArray());
+        $this->assertEquals('{"property":"Hello"}', $object->toJSON());
+    }
+
     /**
      * @dataProvider invalidStringPropertyValueProvider
      *