Add includes and default data

Author: mrjusti

Application/Content/Delivery.php

@@ -46,14 +46,18 @@ public function generate(ApiRequest $apiRequest, ApiEntity $apiEntity)
      *
      * @param ApiRequest $apiRequest
      * @param ApiEntity $apiEntity
+     * @param bool $withRelationships
      * @return Data
      */
-    private function getEntityData(ApiRequest $apiRequest, ApiEntity $apiEntity)
-    {
+    private function getEntityData(
+        ApiRequest $apiRequest,
+        ApiEntity $apiEntity,
+        $withRelationships = true
+    ) {
         return $this->getFormattedEntityData(
             $apiEntity,
             $apiRequest->getFilter($apiEntity->getResourceType()),
-            $apiRequest->getIncludes()
+            $withRelationships
         );
     }
 
@@ -62,10 +66,14 @@ private function getEntityData(ApiRequest $apiRequest, ApiEntity $apiEntity)
      *
      * @param ApiRequest $apiRequest
      * @param ApiEntity $apiEntity
+     * @param bool $withRelationships
      * @return array
      */
-    private function getIncludedData(ApiRequest $apiRequest, ApiEntity $apiEntity)
-    {
+    private function getIncludedData(
+        ApiRequest $apiRequest,
+        ApiEntity $apiEntity,
+        $withRelationships = true
+    ) {
         if (!$apiRequest->hasIncludes()) {
             return [];
         }
@@ -76,7 +84,8 @@ private function getIncludedData(ApiRequest $apiRequest, ApiEntity $apiEntity)
                 $apiRequest,
                 $apiEntity,
                 $entityToInclude,
-                $result
+                $result,
+                $withRelationships
             );
         }
 
@@ -100,30 +109,48 @@ private function getMeta(ApiRequest $apiRequest, ApiEntity $apiEntity)
      * @param ApiRequest $apiRequest
      * @param ApiEntity $apiEntity
      * @param $entityToInclude
-     * @param $result
+     * @param array $result
+     * @param $withRelationships
      * @return array
      */
     private function getFormattedIncludedData(
         ApiRequest $apiRequest,
         ApiEntity $apiEntity,
         $entityToInclude,
-        array $result
+        array $result,
+        $withRelationships
     ) {
         $entities = $apiEntity->{$entityToInclude}();
         if (!is_array($entities)) {
             $entities = [$entities];
         }
 
+        $toIncludes = $apiRequest->getIncludes($entityToInclude);
+
         foreach ($entities as $entity) {
             if (!is_a($entity, 'GoIntegro\Bundle\EndPointBundle\Application\Model\ApiEntity')) {
                 continue;
             }
 
+
+            if (!empty($toIncludes)) {
+                foreach ($toIncludes as $toInclude) {
+                    $includes = [];
+                    $includes = $this->getFormattedIncludedData($apiRequest, $entity, $toInclude, $includes, $withRelationships);
+                    if (!empty($includes)) {
+                        foreach ($includes as $include) {
+                            $result[] = $include;
+                        }
+                    }
+                }
+            }
+
+
             $type = $entity->getResourceType();
             $result[] = $this->getFormattedEntityData(
                 $entity,
                 $apiRequest->getFilter($type),
-                $apiRequest->getIncludes($entityToInclude)
+                $withRelationships
             );
         }
 
@@ -135,11 +162,11 @@ private function getFormattedIncludedData(
      *
      * @param ApiEntity $apiEntity
      * @param $filter
-     * @param $include
+     * @param $withRelationships
      * @return Data
      */
-    private function getFormattedEntityData(ApiEntity $apiEntity, $filter, $include)
+    private function getFormattedEntityData(ApiEntity $apiEntity, $filter, $withRelationships)
     {
-        return $this->contentFormatter->getFormattedEntityData($apiEntity, $filter, $include);
+        return $this->contentFormatter->getFormattedEntityData($apiEntity, $filter, $withRelationships);
     }
 }

Application/Model/ApiEntity.php

@@ -35,4 +35,8 @@ public function getData(array $fields);
      * @return int|null
      */
     public function getRelationshipsMapperType($entity);
+
+    public function getRelationships();
+
+    public function hasRelationships();
 }

Infrastructure/Application/Content/ApiFormatter.php

@@ -18,32 +18,37 @@ class ApiFormatter implements Formatter
      * return the formatted response from and entity and relationships
      *
      * @param Data $entity
-     * @param Data[] $relatedEntities
+     * @param array|\GoIntegro\Bundle\EndPointBundle\Application\Content\Data[] $includedEntities
      * @param array $extra
      * @return array
      */
-    public function response(Data $entity, array $relatedEntities, array $extra = [])
+    public function response(Data $entity, array $includedEntities, array $extra = [])
     {
-        return [
-            $entity->getType() => $entity->toArray(),
-            'linked' => $this->getFormattedIncludedData($relatedEntities),
-            'meta' => $extra,
-        ];
+        $response[$entity->getType()] = $entity->toArray();
+        if (!empty($includedEntities)) {
+            $response['linked'] = $this->getFormattedIncludedData($includedEntities);
+        }
+
+        if (!empty($extra)) {
+            $response['meta'] = $extra;
+        }
+
+        return $response;
     }
 
     /**
      * @param ApiEntity $entity
      * @param $fields
-     * @param $includes
+     * @param bool $withRelationships
      * @return Data
      */
-    public function getFormattedEntityData(ApiEntity $entity, $fields, $includes)
+    public function getFormattedEntityData(ApiEntity $entity, $fields, $withRelationships = true)
     {
         $response = $entity->getData($fields);
-        if (!empty($includes)) {
+        if ($withRelationships && $entity->hasRelationships()) {
             $response['links'] = [];
-            foreach ($includes as $include) {
-                $response['links'][$include] = $this->getFormattedRelationshipData($entity, $include);
+            foreach ($entity->getRelationships() as $relationships) {
+                $response['links'][$relationships] = $this->getFormattedRelationshipData($entity, $relationships);
             }
         }
 
@@ -76,7 +81,7 @@ private function getFormattedIncludedData(array $linkedData)
      * @param $include
      * @return array|int|string
      */
-    private function getFormattedRelationshipData(ApiEntity $entity, $include)
+    public function getFormattedRelationshipData(ApiEntity $entity, $include)
     {
         $content = $entity->{$include}();
         if (empty($content)) {