feat(to-data): add toData-method on FillWithData-Trait

CHANGELOG.md

@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 - [Added method to delete person records](https://github.com/5pm-HDH/churchtools-api/pull/91)
 - [Added Calendar-Request](https://github.com/5pm-HDH/churchtools-api/pull/92)
 - [Added Permission-Request](https://github.com/5pm-HDH/churchtools-api/pull/102)
+- [Serialize Models to Data-Array for JSON-Export](https://github.com/5pm-HDH/churchtools-api/pull/103)
 
 ### Changed
 - [Refactor CTClient:](https://github.com/5pm-HDH/churchtools-api/pull/83) transform inheritance from GuzzleClient to composition-relation

docs/out/Models.md

@@ -44,6 +44,25 @@ Create a collection of models filled with data:
 
 ```
 
+**Convert Model to data**
+
+Convert a model with the `toData`-method (FillWithData-Trait):
+
+```php
+        use CTApi\Models\Person;
+
+        $data = $this->person->toData();
+
+        var_dump( $data["firstName"]);
+        // Output: "John"
+
+        var_dump( $data["meta"]["createdPerson"]["firstName"]);
+        // Output: "Simon"
+
+
+```
+
+
 **`get` and `set`-methods**
 
 The attributes of a model can be used accessed with getters and setter.

docs/src/ressources/Models.md

@@ -14,6 +14,13 @@ Create a collection of models filled with data:
 
 {{ \Tests\Unit\Docs\ModelTest.testCreateModelsFromArray }}
 
+**Convert Model to data**
+
+Convert a model with the `toData`-method (FillWithData-Trait):
+
+{{ \Tests\Unit\Docs\ModelTest.testConvertModelToData }}
+
+
 **`get` and `set`-methods**
 
 The attributes of a model can be used accessed with getters and setter.

src/Models/Traits/FillWithData.php

@@ -7,6 +7,49 @@
 
 trait FillWithData
 {
+    /**
+     * Serialize the Model-Data to associative array. Also converts all properties that are objects to associative array.
+     * @return array data
+     */
+    public function toData(): array
+    {
+        $data = get_object_vars($this);
+        $castedData = [];
+        foreach ($data as $propertyKey => $propertyValue) {
+            $castedData[$propertyKey] = $this->castPropertyToData($propertyValue);
+        }
+        return $castedData;
+    }
+
+    private function castPropertyToData($propertyValue)
+    {
+        if (is_object($propertyValue)) { // cast objects
+            return $this->castObjectToData($propertyValue);
+        } else if (is_array($propertyValue)) {
+            return $this->castArrayToData($propertyValue);
+        } else {
+            return $propertyValue;
+        }
+    }
+
+    private function castArrayToData(array $array): array
+    {
+        return array_map(function ($entry) {
+            return $this->castPropertyToData($entry);
+        }, $array);
+    }
+
+    private function castObjectToData(object $object): ?array
+    {
+        $reflectionClass = new \ReflectionClass($object);
+        $usedTraits = $reflectionClass->getTraitNames();
+
+        if (in_array(FillWithData::class, $usedTraits)) {
+            return $object->toData();
+        }
+        return null;
+    }
+
     private function fillWithData(array $array): void
     {
         foreach ($array as $key => $value) {

tests/unit/Docs/ModelTest.php

@@ -9,6 +9,23 @@
 
 class ModelTest extends TestCase
 {
+    private $person;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+        $this->person = Person::createModelFromData([
+            "id" => 21,
+            "firstName" => "John",
+            "lastName" => "Doe",
+            "meta" => [
+                "createdPerson" => [
+                    "firstName" => "Simon"
+                ]
+            ]
+        ]);
+    }
+
     /**
      * @doesNotPerformAssertions
      */
@@ -40,6 +57,14 @@ public function testCreateModelsFromArray()
         $this->assertEquals("Kling/ Maier/ ", $lastNames);
     }
 
+    public function testConvertModelToData()
+    {
+        $data = $this->person->toData();
+
+        $this->assertEquals("John", $data["firstName"]);
+        $this->assertEquals("Simon", $data["meta"]["createdPerson"]["firstName"]);
+    }
+
     /**
      * @doesNotPerformAssertions
      */

tests/unit/Models/FillWithDataTraitToData.php

@@ -0,0 +1,32 @@
+<?php
+
+
+namespace Tests\Unit\Models;
+
+
+use CTApi\Models\Traits\FillWithData;
+use CTApi\Requests\SongRequest;
+use PHPUnit\Framework\TestCase;
+use Tests\Unit\TestCaseHttpMocked;
+
+class FillWithDataTraitToData extends TestCaseHttpMocked
+{
+    public function testCreateSong()
+    {
+        $song = SongRequest::find(21);
+
+        $this->assertNotNull($song);
+
+        $data = $song->toData();
+
+        $this->assertNotEmpty($data);
+        $this->assertEquals("21", $data["id"]);
+        $this->assertEquals("We welcome you", $data["name"]);
+
+        // Check that Model-Properties are also casted to array
+        $this->assertNotEmpty($data["arrangements"]);
+        $lastArrangement = end($data["arrangements"]);
+        $this->assertIsArray($lastArrangement);
+        $this->assertEquals("221", $lastArrangement["id"]);
+    }
+}