Compound Documents (#10)

* Added copyright

* Formatting

* Compound Documents

Author: f3ath

src/Document/Document.php

@@ -14,6 +14,8 @@
 
 namespace JsonApiPhp\JsonApi\Document;
 
+use JsonApiPhp\JsonApi\Document\Resource\IdentifiableResource;
+use JsonApiPhp\JsonApi\Document\Resource\ResourceObject;
 use JsonApiPhp\JsonApi\HasLinksAndMeta;
 
 final class Document implements \JsonSerializable
@@ -23,11 +25,13 @@ final class Document implements \JsonSerializable
 
     use HasLinksAndMeta;
 
-    protected $data;
-    protected $errors;
-    protected $meta;
-    protected $jsonapi;
-    protected $links;
+    private $data;
+    private $errors;
+    private $meta;
+    private $jsonapi;
+    private $links;
+    private $included;
+    private $sparse = false;
 
     /**
      * Use named constructors instead
@@ -50,14 +54,14 @@ public static function fromErrors(Error ...$errors): self
         return $doc;
     }
 
-    public static function fromData(PrimaryDataInterface $data): self
+    public static function fromResource(IdentifiableResource $data): self
     {
         $doc = new self;
         $doc->data = $data;
         return $doc;
     }
 
-    public static function fromDataItems(PrimaryDataItemInterface ...$data): self
+    public static function fromResources(IdentifiableResource ...$data): self
     {
         $doc = new self;
         $doc->data = $data;
@@ -74,19 +78,68 @@ public function setApiMeta(array $meta): void
         $this->jsonapi['meta'] = $meta;
     }
 
+    public function setIncluded(IdentifiableResource ...$included)
+    {
+        $this->included = $included;
+    }
+
+    public function setSparse()
+    {
+        $this->sparse = true;
+    }
+
     public function jsonSerialize()
     {
+        if ($this->included && !$this->sparse) {
+            foreach ($this->included as $resource) {
+                if ($this->hasLinkTo($resource)) {
+                    continue;
+                }
+                throw new \LogicException("Full linkage is required for $resource");
+            }
+        }
         return array_filter(
             [
-                'data'    => $this->data,
-                'errors'  => $this->errors,
-                'meta'    => $this->meta,
+                'data' => $this->data,
+                'errors' => $this->errors,
+                'meta' => $this->meta,
                 'jsonapi' => $this->jsonapi,
-                'links'   => $this->links,
+                'links' => $this->links,
+                'included' => $this->included,
             ],
             function ($v) {
                 return null !== $v;
             }
         );
     }
+
+    private function hasLinkTo(IdentifiableResource $resource): bool
+    {
+        if (!$this->data) {
+            return false;
+        }
+
+        foreach ($this->toDataItems() as $my_resource) {
+            if ($my_resource instanceof ResourceObject) {
+                if ($my_resource->hasRelationTo($resource)) {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
+
+    /**
+     * @return IdentifiableResource[]
+     */
+    private function toDataItems(): array
+    {
+        if ($this->data instanceof IdentifiableResource) {
+            return [$this->data];
+        } elseif (is_array($this->data)) {
+            return $this->data;
+        } else {
+            return [];
+        }
+    }
 }

src/Document/PrimaryDataInterface.php

@@ -0,0 +1,29 @@
+<?php
+/**
+ *
+ *  * This file is part of JSON:API implementation for PHP.
+ *  *
+ *  * (c) Alexey Karapetov <[email protected]>
+ *  *
+ *  * For the full copyright and license information, please view the LICENSE
+ *  * file that was distributed with this source code.
+ *
+ */
+
+namespace JsonApiPhp\JsonApi\Document\Resource;
+
+abstract class IdentifiableResource implements \JsonSerializable
+{
+    protected $id;
+    protected $type;
+
+    public function isEqualTo(IdentifiableResource $that): bool
+    {
+        return $this->type === $that->type && $this->id === $that->id;
+    }
+
+    public function __toString()
+    {
+        return "$this->type:$this->id";
+    }
+}

src/Document/PrimaryDataItemInterface.php

@@ -14,10 +14,13 @@
 
 namespace JsonApiPhp\JsonApi\Document\Resource;
 
-use JsonApiPhp\JsonApi\Document\PrimaryDataInterface;
-
-final class NullDataInterface implements PrimaryDataInterface
+final class NullData extends IdentifiableResource
 {
+    public function isEqualTo(IdentifiableResource $that): bool
+    {
+        return false;
+    }
+
     public function jsonSerialize()
     {
         return null;

src/Document/Resource/IdentifiableResource.php

@@ -14,6 +14,7 @@
 
 namespace JsonApiPhp\JsonApi\Document\Resource\Relationship;
 
+use JsonApiPhp\JsonApi\Document\Resource\IdentifiableResource;
 use JsonApiPhp\JsonApi\Document\Resource\ResourceId;
 
 final class Linkage implements \JsonSerializable
@@ -50,6 +51,18 @@ public static function fromManyResourceIds(ResourceId ...$data): self
         return $linkage;
     }
 
+    public function isLinkedTo(IdentifiableResource $resource): bool
+    {
+        if ($this->data) {
+            foreach ((array)$this->data as $my_resource) {
+                if ($resource->isEqualTo($my_resource)) {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
+
     public function jsonSerialize()
     {
         return $this->data;

src/Document/Resource/NullDataInterface.php renamed to src/Document/Resource/NullData.php

@@ -14,13 +14,17 @@
 
 namespace JsonApiPhp\JsonApi\Document\Resource\Relationship;
 
+use JsonApiPhp\JsonApi\Document\Resource\IdentifiableResource;
 use JsonApiPhp\JsonApi\HasLinksAndMeta;
 
 final class Relationship implements \JsonSerializable
 {
     use HasLinksAndMeta;
 
-    private $data;
+    /**
+     * @var Linkage
+     */
+    private $linkage = null;
     private $meta;
     private $links;
 
@@ -49,18 +53,23 @@ public static function fromRelatedLink(string $link, array $meta = null): self
         return $r;
     }
 
-    public static function fromLinkage(Linkage $data): self
+    public static function fromLinkage(Linkage $linkage): self
     {
         $r = new self;
-        $r->data = $data;
+        $r->linkage = $linkage;
         return $r;
     }
 
+    public function isLinkedTo(IdentifiableResource $resource): bool
+    {
+        return ($this->linkage && $this->linkage->isLinkedTo($resource));
+    }
+
     public function jsonSerialize()
     {
         return array_filter(
             [
-                'data'  => $this->data,
+                'data'  => $this->linkage,
                 'links' => $this->links,
                 'meta'  => $this->meta,
             ],

src/Document/Resource/Relationship/Linkage.php

@@ -14,16 +14,12 @@
 
 namespace JsonApiPhp\JsonApi\Document\Resource;
 
-use JsonApiPhp\JsonApi\Document\PrimaryDataInterface;
-use JsonApiPhp\JsonApi\Document\PrimaryDataItemInterface;
 use JsonApiPhp\JsonApi\HasMeta;
 
-final class ResourceId implements PrimaryDataInterface, PrimaryDataItemInterface
+final class ResourceId extends IdentifiableResource
 {
     use HasMeta;
 
-    private $type;
-    private $id;
     private $meta;
 
     public function __construct(string $type, string $id = null, array $meta = [])

src/Document/Resource/Relationship/Relationship.php

@@ -14,17 +14,13 @@
 
 namespace JsonApiPhp\JsonApi\Document\Resource;
 
-use JsonApiPhp\JsonApi\Document\PrimaryDataInterface;
-use JsonApiPhp\JsonApi\Document\PrimaryDataItemInterface;
 use JsonApiPhp\JsonApi\Document\Resource\Relationship\Relationship;
 use JsonApiPhp\JsonApi\HasLinksAndMeta;
 
-final class ResourceObject implements PrimaryDataInterface, PrimaryDataItemInterface
+final class ResourceObject extends IdentifiableResource
 {
     use HasLinksAndMeta;
 
-    private $id;
-    private $type;
     private $meta;
     private $links;
     private $attributes;
@@ -55,16 +51,34 @@ public function setRelationship(string $name, Relationship $relationship): void
         $this->relationships[$name] = $relationship;
     }
 
+    public function hasRelationTo(IdentifiableResource $resource): bool
+    {
+        if ($this->relationships) {
+            /** @var Relationship $relationship */
+            foreach ($this->relationships as $relationship) {
+                if ($relationship->isLinkedTo($resource)) {
+                    return true;
+                }
+            }
+        }
+        return false;
+    }
+
+    public function toId(): ResourceId
+    {
+        return new ResourceId($this->type, $this->id);
+    }
+
     public function jsonSerialize()
     {
         return array_filter(
             [
-                'type'          => $this->type,
-                'id'            => $this->id,
-                'attributes'    => $this->attributes,
+                'type' => $this->type,
+                'id' => $this->id,
+                'attributes' => $this->attributes,
                 'relationships' => $this->relationships,
-                'links'         => $this->links,
-                'meta'          => $this->meta,
+                'links' => $this->links,
+                'meta' => $this->meta,
             ],
             function ($v) {
                 return null !== $v;