JSONAPI Included resources now include the relationships member too when needed

Author: nilportugues

src/Helpers/DataIncludedHelper.php

@@ -100,16 +100,58 @@ private static function addToIncludedArray(array &$mappings, array &$data, array
             $includedData = PropertyHelper::setResponseDataTypeAndId($mappings, $value);
 
             if (self::hasIdKey($includedData)) {
-                $data[JsonApiTransformer::INCLUDED_KEY][] = array_filter(
-                    array_merge(
-                        [
-                            JsonApiTransformer::TYPE_KEY => $includedData[JsonApiTransformer::TYPE_KEY],
-                            JsonApiTransformer::ID_KEY => $includedData[JsonApiTransformer::ID_KEY],
-                            JsonApiTransformer::ATTRIBUTES_KEY => $attributes,
-                        ],
-                        DataLinksHelper::setResponseDataLinks($mappings, $value)
-                    )
+                $arrayData = array_merge(
+                    [
+                        JsonApiTransformer::TYPE_KEY => $includedData[JsonApiTransformer::TYPE_KEY],
+                        JsonApiTransformer::ID_KEY => $includedData[JsonApiTransformer::ID_KEY],
+                        JsonApiTransformer::ATTRIBUTES_KEY => $attributes,
+                        JsonApiTransformer::RELATIONSHIPS_KEY => [],
+                    ],
+                    DataLinksHelper::setResponseDataLinks($mappings, $value)
+                );
+
+                $relationshipData = [];
+                self::addRelationshipsToIncludedResources(
+                    $mappings,
+                    $relationshipData,
+                    $value,
+                    $value[Serializer::CLASS_IDENTIFIER_KEY],
+                    $attributes
                 );
+
+                if ($relationshipData) {
+                    $arrayData[JsonApiTransformer::RELATIONSHIPS_KEY] = array_merge(
+                        $arrayData[JsonApiTransformer::RELATIONSHIPS_KEY],
+                        $relationshipData
+                    );
+                }
+
+                $data[JsonApiTransformer::INCLUDED_KEY][] = array_filter($arrayData);
+            }
+        }
+    }
+
+    /**
+     * @param array  $mappings
+     * @param array  $data
+     * @param array  $value
+     * @param string $type
+     */
+    private static function addRelationshipsToIncludedResources(
+        array &$mappings,
+        array &$data,
+        array &$value,
+        $type
+    ) {
+        foreach ($value as $propertyName => $attribute) {
+            if (PropertyHelper::isAttributeProperty($mappings, $propertyName, $type)) {
+                $propertyName = DataAttributesHelper::transformToValidMemberName($propertyName);
+
+                if (is_array($attribute) && array_key_exists(Serializer::CLASS_IDENTIFIER_KEY, $attribute)) {
+                    $data[$propertyName][JsonApiTransformer::DATA_KEY] = PropertyHelper::setResponseDataTypeAndId($mappings, $attribute);
+
+                    continue;
+                }
             }
         }
     }

tests/JsonApiTransformerTest.php

@@ -210,6 +210,14 @@ public function testItWillSerializeToJsonApiAComplexObject()
                 },
                 "comment": "Have no fear, sers, your king is safe."
             },
+            "relationships": {
+                "user": {
+                    "data": {
+                        "type": "user",
+                        "id": "2"
+                    }
+                }
+            },
             "links": {
                 "self": { "href": "http://example.com/comments/1000" }
             }