Add links for all available includes to JsonApiSerializer (#331)

* Add links for all available includes to JsonApiSerializer * Update JsonApiSerializer test
thephpleague · Jun 29, 2019 · f1a3d71 · f1a3d71
1 parent 8583018
commit f1a3d71
Show file tree

Hide file tree

Showing 4 changed files with 451 additions and 31 deletions.
diff --git a/src/Scope.php b/src/Scope.php
@@ -262,6 +262,10 @@ public function toArray()
             $data = $data + $includedData;
         }
 
+        if (!empty($this->availableIncludes)) {
+            $data = $serializer->injectAvailableIncludeData($data, $this->availableIncludes);
+        }
+
         if ($this->resource instanceof Collection) {
             if ($this->resource->hasCursor()) {
                 $pagination = $serializer->cursor($this->resource->getCursor());

diff --git a/src/Serializer/JsonApiSerializer.php b/src/Serializer/JsonApiSerializer.php
@@ -468,15 +468,6 @@ private function fillRelationshipAsCollection($data, $relationship, $key)
     {
         foreach ($relationship as $index => $relationshipData) {
             $data['data'][$index]['relationships'][$key] = $relationshipData;
-
-            if ($this->shouldIncludeLinks()) {
-                $data['data'][$index]['relationships'][$key] = array_merge([
-                    'links' => [
-                        'self' => "{$this->baseUrl}/{$data['data'][$index]['type']}/{$data['data'][$index]['id']}/relationships/$key",
-                        'related' => "{$this->baseUrl}/{$data['data'][$index]['type']}/{$data['data'][$index]['id']}/$key",
-                    ],
-                ], $data['data'][$index]['relationships'][$key]);
-            }
         }
 
         return $data;
@@ -494,16 +485,6 @@ private function fillRelationshipAsSingleResource($data, $relationship, $key)
     {
         $data['data']['relationships'][$key] = $relationship[0];
 
-        if ($this->shouldIncludeLinks()) {
-            $data['data']['relationships'][$key] = array_merge([
-                'links' => [
-                    'self' => "{$this->baseUrl}/{$data['data']['type']}/{$data['data']['id']}/relationships/$key",
-                    'related' => "{$this->baseUrl}/{$data['data']['type']}/{$data['data']['id']}/$key",
-                ],
-            ], $data['data']['relationships'][$key]);
-
-            return $data;
-        }
         return $data;
     }
 
@@ -577,6 +558,56 @@ private function addIncludedDataToRelationship($includeObject, $relationship)
         return $relationship;
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function injectAvailableIncludeData($data, $availableIncludes)
+    {
+        if (!$this->shouldIncludeLinks()) {
+            return $data;
+        }
+
+        if ($this->isCollection($data)) {
+            $data['data'] = array_map(function ($resource) use ($availableIncludes) {
+                foreach ($availableIncludes as $relationshipKey) {
+                    $resource = $this->addRelationshipLinks($resource, $relationshipKey);
+                }
+                return $resource;
+            }, $data['data']);
+        } else {
+            foreach ($availableIncludes as $relationshipKey) {
+                $data['data'] = $this->addRelationshipLinks($data['data'], $relationshipKey);
+            }
+        }
+
+        return $data;
+    }
+
+    /**
+     * Adds links for all available includes to a single resource.
+     *
+     * @param array $resource         The resource to add relationship links to
+     * @param string $relationshipKey The resource key of the relationship
+     */
+    private function addRelationshipLinks($resource, $relationshipKey)
+    {
+        if (!isset($resource['relationships']) || !isset($resource['relationships'][$relationshipKey])) {
+            $resource['relationships'][$relationshipKey] = [];
+        }
+
+        $resource['relationships'][$relationshipKey] = array_merge(
+            [
+                'links' => [
+                    'self'   => "{$this->baseUrl}/{$resource['type']}/{$resource['id']}/relationships/{$relationshipKey}",
+                    'related' => "{$this->baseUrl}/{$resource['type']}/{$resource['id']}/{$relationshipKey}",
+                ]
+            ],
+            $resource['relationships'][$relationshipKey]
+        );
+
+        return $resource;
+    }
+
     /**
      * @param $includeObjects
      * @param $linkedIds

diff --git a/src/Serializer/SerializerAbstract.php b/src/Serializer/SerializerAbstract.php
@@ -115,6 +115,19 @@ public function injectData($data, $rawIncludedData)
         return $data;
     }
 
+    /**
+     * Hook for the serializer to inject custom data based on the available includes of the resource.
+     *
+     * @param array $data
+     * @param array $availableIncludes
+     *
+     * @return array
+     */
+    public function injectAvailableIncludeData($data, $availableIncludes)
+    {
+        return $data;
+    }
+
     /**
      * Hook for the serializer to modify the final list of includes.
      *