Allow relationships to be mapped into another output key

Author: Michael Lundbøl

src/Transformers/ApiTransformer.php

@@ -131,25 +131,27 @@ protected function transformRelationships(array $output, Model $data): array
                 continue;
             }
 
+            $outputKey = $this->findNewKey($relationshipName);
+
             if (null === $relationship) {
-                $output[$relationshipName] = $this->convertValueType($relationshipName, null);
+                $output[$outputKey] = $this->convertValueType($relationshipName, null);
             } elseif (true === $relationship instanceof Collection) {
                 if ($relationship->isEmpty()) {
-                    $output[$relationshipName] = $this->convertValueType($relationshipName, null);
+                    $output[$outputKey] = $this->convertValueType($relationshipName, null);
                     continue;
                 }
 
                 if ($this->isTransformAware($relationship->first())) {
-                    $output[$relationshipName] = $relationship->first()->getTransformer()->transformOutput($relationship);
+                    $output[$outputKey] = $relationship->first()->getTransformer()->transformOutput($relationship);
                 } else {
-                    $output[$relationshipName] = $relationship->toArray();
+                    $output[$outputKey] = $relationship->toArray();
                 }
             } else {
                 // model
                 if ($this->isTransformAware($relationship)) {
-                    $output[$relationshipName] = $relationship->getTransformer()->transformOutput($relationship);
+                    $output[$outputKey] = $relationship->getTransformer()->transformOutput($relationship);
                 } else {
-                    $output[$relationshipName] = $relationship->getAttributes();
+                    $output[$outputKey] = $relationship->getAttributes();
                 }
             }
         }

tests/ApiTransformerTest.php

@@ -6,6 +6,7 @@
 use Napp\Core\Api\Tests\Models\Post;
 use Napp\Core\Api\Tests\Models\Product;
 use Napp\Core\Api\Tests\Transformers\CategoryStrictTransformer;
+use Napp\Core\Api\Tests\Transformers\CategoryTransformerWithDifferentOutputKey;
 use Napp\Core\Api\Tests\Transformers\PostTransformer;
 use Napp\Core\Api\Tests\Transformers\ProductTransformer;
 use Napp\Core\Api\Transformers\ApiTransformer;
@@ -323,8 +324,21 @@ public function test_transform_model_relations_is_exluded_if_not_found_in_transf
         $category->products()->create(['name' => 'iPhone', 'price'=> 100.0]);
         $category->load('products');
 
-        $result = (new CategoryStrictTransformer())->transformOutput($category);
+        $result = (new CategoryStrictTransformer)->transformOutput($category);
 
         $this->assertArrayNotHasKey('products', $result);
     }
+
+    public function test_transform_model_relations_with_different_output_key()
+    {
+        /** @var Category $category */
+        $category = Category::create(['title' => 'Electronics']);
+        $category->products()->create(['name' => 'iPhone', 'price'=> 100.0]);
+        $category->load('products');
+
+        $result = (new CategoryTransformerWithDifferentOutputKey)->transformOutput($category);
+
+        $this->assertArrayNotHasKey('products', $result);
+        $this->assertArrayHasKey('indexes', $result);
+    }
 }

tests/Transformers/CategoryTransformerWithDifferentOutputKey.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace Napp\Core\Api\Tests\Transformers;
+
+use Napp\Core\Api\Transformers\ApiTransformer;
+
+class CategoryTransformerWithDifferentOutputKey extends ApiTransformer
+{
+    public function __construct()
+    {
+        $this->setApiMapping([
+            'id'         => ['newName' => 'id',         'dataType' => 'int'],
+            'title'      => ['newName' => 'name',       'dataType' => 'string'],
+            'products'   => ['newName' => 'indexes',     'dataType' => 'array'],
+        ]);
+    }
+}