Improved transformation of relationships

woohoolabs · Jul 13, 2015 · 60ffaeb · 60ffaeb
1 parent 55d1b8f
commit 60ffaeb
Show file tree

Hide file tree

Showing 11 changed files with 138 additions and 80 deletions.
diff --git a/src/JsonApi/Request/Criteria.php b/src/JsonApi/Request/Criteria.php
@@ -78,9 +78,7 @@ public function isIncludedField($resourceType, $field)
      */
     protected function setIncludedRelationships()
     {
-        foreach ($this->getQueryParam("include", []) as $relationshipPath => $includes) {
-            $this->includedFields[$relationshipPath] = explode(",", $includes);
-        }
+        $this->includedRelationships = array_flip(explode(",", $this->getQueryParam("include", "")));
     }
 
     /**

diff --git a/src/JsonApi/Schema/AbstractRelationship.php b/src/JsonApi/Schema/AbstractRelationship.php
@@ -9,32 +9,77 @@ abstract class AbstractRelationship
     use LinksTrait;
     use MetaTrait;
 
-    abstract protected function addResource(array $resourceIdentifier);
+    /**
+     * @var mixed
+     */
+    protected $data;
+
+    /**
+     * @var \WoohooLabs\Yin\JsonApi\Transformer\ResourceTransformerInterface
+     */
+    protected $resourceTransformer;
+
+    /**
+     * @param mixed $data
+     * @param \WoohooLabs\Yin\JsonApi\Transformer\ResourceTransformerInterface $resourceTransformer
+     */
+    public function __construct($data, ResourceTransformerInterface $resourceTransformer)
+    {
+        $this->data = $data;
+        $this->resourceTransformer = $resourceTransformer;
+    }
+
+    /**
+     * @param \WoohooLabs\Yin\JsonApi\Request\Criteria $criteria
+     * @param \WoohooLabs\Yin\JsonApi\Schema\Included $includes
+     * @param string $relationshipPath
+     * @return array
+     */
+    abstract protected function transformData(Criteria $criteria, Included $includes, $relationshipPath);
+
+    /**
+     * @param \WoohooLabs\Yin\JsonApi\Request\Criteria $criteria
+     * @param \WoohooLabs\Yin\JsonApi\Schema\Included $includes
+     * @param string $relationshipPath
+     * @return array
+     */
+    public function transform(Criteria $criteria, Included $includes, $relationshipPath)
+    {
+        $relationship = [];
+
+        // LINKS
+        if ($this->links !== null) {
+            $relationship["links"] = $this->links->transform();
+        }
+
+        // META
+        if (empty($this->meta) === false) {
+            $relationship["meta"] = $this->meta;
+        }
+
+        // DATA
+        if ($this->data !== null) {
+            $relationship["data"] = $this->transformData($criteria, $includes, $relationshipPath);
+        }
+
+        return $relationship;
+    }
 
     /**
      * @param mixed $resource
-     * @param \WoohooLabs\Yin\JsonApi\Transformer\ResourceTransformerInterface $transformer
      * @param \WoohooLabs\Yin\JsonApi\Request\Criteria $criteria
      * @param \WoohooLabs\Yin\JsonApi\Schema\Included $includes
      * @param string $relationshipPath
+     * @return array
      */
-    public function includeRelationship(
-        $resource,
-        ResourceTransformerInterface $transformer,
-        Criteria $criteria,
-        Included $includes,
-        $relationshipPath
-    ) {
-        $this->addResource($transformer->transformToResourceIdentifier($resource));
+    protected function transformResource($resource, Criteria $criteria, Included $includes, $relationshipPath)
+    {
         if ($criteria->isIncludedRelationship($relationshipPath)) {
             $includes->addIncludedResource(
-                $transformer->transformToResource(
-                    $resource,
-                    $criteria,
-                    $includes,
-                    $relationshipPath
-                )
+                $this->resourceTransformer->transformToResource($resource, $criteria, $includes, $relationshipPath)
             );
         }
+
+        return $this->resourceTransformer->transformToResourceIdentifier($resource);
     }
 }
diff --git a/src/JsonApi/Schema/LinkObject.php b/src/JsonApi/Schema/LinkObject.php
@@ -21,7 +21,10 @@ public function __construct($href, array $meta = [])
     public function transform()
     {
         $link = ["href" => parent::transform()];
-        $this->addTransformedMetaToArray($link);
+
+        if (empty($this->meta) === false) {
+            $link["meta"] = $this->meta;
+        }
 
         return $link;
     }

diff --git a/src/JsonApi/Schema/LinksTrait.php b/src/JsonApi/Schema/LinksTrait.php
@@ -1,14 +1,12 @@
 <?php
 namespace WoohooLabs\Yin\JsonApi\Schema;
 
-use WoohooLabs\Yin\JsonApi\Request\Criteria;
-
 trait LinksTrait
 {
     /**
      * @var \WoohooLabs\Yin\JsonApi\Schema\Links
      */
-    private $links;
+    protected $links;
 
     /**
      * @param \WoohooLabs\Yin\JsonApi\Schema\Links $links
@@ -20,15 +18,4 @@ public function setLinks(Links $links)
 
         return $this;
     }
-
-    /**
-     * @param \WoohooLabs\Yin\JsonApi\Request\Criteria $criteria
-     * @param array $array
-     */
-    public function addTransformedLinksToArray(array &$array, Criteria $criteria)
-    {
-        if ($this->links !== null) {
-            $array["links"] = $this->links->transform($criteria);
-        }
-    }
 }
diff --git a/src/JsonApi/Schema/MetaTrait.php b/src/JsonApi/Schema/MetaTrait.php
@@ -6,7 +6,7 @@ trait MetaTrait
     /**
      * @var array
      */
-    private $meta;
+    protected $meta = [];
 
     /**
      * @param array $meta
@@ -18,14 +18,4 @@ public function setMeta(array $meta)
 
         return $this;
     }
-
-    /**
-     * @param array $array
-     */
-    public function addTransformedMetaToArray(array &$array)
-    {
-        if (empty($this->meta) === false) {
-            $array["meta"] = $this->meta;
-        }
-    }
 }
diff --git a/src/JsonApi/Schema/OneToManyArrayRelationship.php b/src/JsonApi/Schema/OneToManyArrayRelationship.php
@@ -0,0 +1,34 @@
+<?php
+namespace WoohooLabs\Yin\JsonApi\Schema;
+
+use WoohooLabs\Yin\JsonApi\Request\Criteria;
+use WoohooLabs\Yin\JsonApi\Transformer\ResourceTransformerInterface;
+
+class OneToManyArrayRelationship extends AbstractRelationship
+{
+    /**
+     * @param array $data
+     * @param \WoohooLabs\Yin\JsonApi\Transformer\ResourceTransformerInterface $resourceTransformer
+     */
+    public function __construct(array $data, ResourceTransformerInterface $resourceTransformer)
+    {
+        parent::__construct($data, $resourceTransformer);
+    }
+
+    /**
+     * @param \WoohooLabs\Yin\JsonApi\Request\Criteria $criteria
+     * @param \WoohooLabs\Yin\JsonApi\Schema\Included $includes
+     * @param string $relationshipPath
+     * @return array
+     */
+    protected function transformData(Criteria $criteria, Included $includes, $relationshipPath)
+    {
+        $result = [];
+
+        foreach ($this->data as $item) {
+            $result[] = $this->transformResource($item, $criteria, $includes, $relationshipPath);
+        }
+
+        return $result;
+    }
+}
diff --git a/src/JsonApi/Schema/OneToManyRelationship.php b/src/JsonApi/Schema/OneToManyRelationship.php
diff --git a/src/JsonApi/Schema/OneToOneRelationship.php b/src/JsonApi/Schema/OneToOneRelationship.php
@@ -1,18 +1,28 @@
 <?php
 namespace WoohooLabs\Yin\JsonApi\Schema;
 
-class OneToOneAbstractRelationship extends AbstractRelationship
+use WoohooLabs\Yin\JsonApi\Request\Criteria;
+use WoohooLabs\Yin\JsonApi\Transformer\ResourceTransformerInterface;
+
+class OneToOneRelationship extends AbstractRelationship
 {
     /**
-     * @var \WoohooLabs\Yin\JsonApi\Schema\ResourceIdentifier
+     * @param mixed $data
+     * @param \WoohooLabs\Yin\JsonApi\Transformer\ResourceTransformerInterface $resourceTransformer
      */
-    private $data;
+    public function __construct($data, ResourceTransformerInterface $resourceTransformer)
+    {
+        parent::__construct($data, $resourceTransformer);
+    }
 
     /**
-     * @param array $resource
+     * @param \WoohooLabs\Yin\JsonApi\Request\Criteria $criteria
+     * @param \WoohooLabs\Yin\JsonApi\Schema\Included $includes
+     * @param string $relationshipPath
+     * @return array
      */
-    public function addResource(array $resource)
+    protected function transformData(Criteria $criteria, Included $includes, $relationshipPath)
     {
-        $this->data = $resource;
+        return $this->transformResource($this->data, $criteria, $includes, $relationshipPath);
     }
 }
diff --git a/src/JsonApi/Schema/Relationships.php b/src/JsonApi/Schema/Relationships.php
@@ -39,16 +39,23 @@ public function setRelationship($rel, \Closure $relationship)
      * @param mixed $resource
      * @param \WoohooLabs\Yin\JsonApi\Request\Criteria $criteria
      * @param \WoohooLabs\Yin\JsonApi\Schema\Included $included
-     * @param string $relationshipPath
+     * @param string $baseRelationshipPath
      * @return array
      */
-    public function transform($resource, Criteria $criteria, Included $included, $relationshipPath)
-    {
+    public function transform(
+        $resource,
+        Criteria $criteria,
+        Included $included,
+        $baseRelationshipPath
+    ) {
         $relationships = [];
 
-        foreach ($this->relationships as $rel => $relationship) {
-            if ($criteria->isIncludedRelationship($relationshipPath . "." . $rel)) {
-                $relationships[$rel] = $relationship($resource, $criteria, $included);
+        foreach ($this->relationships as $rel => $relationshipCallback) {
+            $relationshipPath = ($baseRelationshipPath ? "$baseRelationshipPath." : "") . $rel;
+            if ($criteria->isIncludedRelationship($relationshipPath)) {
+                /** @var \WoohooLabs\Yin\JsonApi\Schema\AbstractRelationship $relationship */
+                $relationship = $relationshipCallback($resource);
+                $relationships[$rel] = $relationship->transform($criteria, $included, $relationshipPath);
             }
         }
 

diff --git a/src/JsonApi/Transformer/AbstractErrorDocument.php b/src/JsonApi/Transformer/AbstractErrorDocument.php
@@ -2,6 +2,7 @@
 namespace WoohooLabs\Yin\JsonApi\Transformer;
 
 use Psr\Http\Message\ResponseInterface;
+use WoohooLabs\Yin\JsonApi\Request\Criteria;
 use WoohooLabs\Yin\JsonApi\Schema\Error;
 
 abstract class AbstractErrorDocument extends AbstractDocument
@@ -28,11 +29,12 @@ public function addError(Error $error)
     }
 
     /**
+     * @param \WoohooLabs\Yin\JsonApi\Request\Criteria $criteria
      * @return array
      */
-    protected function transformContent()
+    protected function transformContent(Criteria $criteria)
     {
-        $content = parent::transformContent();
+        $content = parent::transformContent($criteria);
 
         // ERRORS
         if (empty($this->errors) === false) {

diff --git a/src/JsonApi/Transformer/AbstractResourceTransformer.php b/src/JsonApi/Transformer/AbstractResourceTransformer.php
@@ -118,19 +118,19 @@ private function transformAttributes(array &$array, $resource, Criteria $criteri
      * @param mixed $resource
      * @param \WoohooLabs\Yin\JsonApi\Request\Criteria $criteria
      * @param \WoohooLabs\Yin\JsonApi\Schema\Included $included
-     * @param string $relationshipPath
+     * @param string $baseRelationshipPath
      */
     private function transformRelationships(
         array &$array,
         $resource,
         Criteria $criteria,
         Included $included,
-        $relationshipPath
+        $baseRelationshipPath
     ) {
         $relationships = $this->getRelationships($resource);
 
         if ($relationships !== null) {
-            $array["relationships"] = $relationships->transform($resource, $criteria, $included, $relationshipPath);
+            $array["relationships"] = $relationships->transform($resource, $criteria, $included, $baseRelationshipPath);
         }
     }
 }