Move jsonSerialize and toArray to Document(Interface)

Author: JaZo

src/CollectionDocument.php

@@ -4,50 +4,6 @@
 
 use Swis\JsonApi\Client\Interfaces\CollectionDocumentInterface;
 
-class CollectionDocument extends Document implements CollectionDocumentInterface, \JsonSerializable
+class CollectionDocument extends Document implements CollectionDocumentInterface
 {
-    /**
-     * Specify data which should be serialized to JSON.
-     *
-     * @see  http://php.net/manual/en/jsonserializable.jsonserialize.php
-     *
-     * @return mixed data which can be serialized by <b>json_encode</b>,
-     *               which is a value of any type other than a resource
-     *
-     * @since 5.4.0
-     */
-    public function jsonSerialize()
-    {
-        return $this->toArray();
-    }
-
-    /**
-     * @return array
-     */
-    public function toArray(): array
-    {
-        $document = [];
-
-        if (!empty($this->getLinks())) {
-            $document['links'] = $this->links;
-        }
-
-        if (!empty($this->getData())) {
-            $document['data'] = $this->data->toJsonApiArray();
-        }
-
-        if (!empty($this->getMeta())) {
-            $document['meta'] = $this->meta;
-        }
-
-        if ($this->hasErrors()) {
-            $document['errors'] = $this->errors->toArray();
-        }
-
-        if (!empty($this->getJsonapi())) {
-            $document['jsonapi'] = $this->jsonapi;
-        }
-
-        return $document;
-    }
 }

src/Document.php

@@ -6,7 +6,7 @@
 use Swis\JsonApi\Client\Interfaces\DataInterface;
 use Swis\JsonApi\Client\Interfaces\DocumentInterface;
 
-class Document implements DocumentInterface
+class Document implements DocumentInterface, \JsonSerializable
 {
     /**
      * @var \Swis\JsonApi\Client\Interfaces\DataInterface
@@ -155,4 +155,53 @@ public function setData(DataInterface $data)
 
         return $this;
     }
+
+    /**
+     * Specify data which should be serialized to JSON.
+     *
+     * @see  http://php.net/manual/en/jsonserializable.jsonserialize.php
+     *
+     * @return mixed data which can be serialized by <b>json_encode</b>,
+     *               which is a value of any type other than a resource
+     *
+     * @since 5.4.0
+     */
+    public function jsonSerialize()
+    {
+        return $this->toArray();
+    }
+
+    /**
+     * @return array
+     */
+    public function toArray(): array
+    {
+        $document = [];
+
+        if (!empty($this->getLinks())) {
+            $document['links'] = $this->links;
+        }
+
+        if (!empty($this->getData())) {
+            $document['data'] = $this->data->toJsonApiArray();
+        }
+
+        if ($this->getIncluded()->isNotEmpty()) {
+            $document['included'] = $this->getIncluded()->toJsonApiArray();
+        }
+
+        if (!empty($this->getMeta())) {
+            $document['meta'] = $this->meta;
+        }
+
+        if ($this->hasErrors()) {
+            $document['errors'] = $this->errors->toArray();
+        }
+
+        if (!empty($this->getJsonapi())) {
+            $document['jsonapi'] = $this->jsonapi;
+        }
+
+        return $document;
+    }
 }

src/Interfaces/DocumentInterface.php

@@ -17,6 +17,11 @@ public function getData();
      */
     public function getErrors(): ErrorCollection;
 
+    /**
+     * @return bool
+     */
+    public function hasErrors(): bool;
+
     /**
      * @return mixed
      */
@@ -38,7 +43,7 @@ public function getIncluded(): Collection;
     public function getJsonapi();
 
     /**
-     * @return bool
+     * @return array
      */
-    public function hasErrors(): bool;
+    public function toArray(): array;
 }

src/Interfaces/ItemDocumentInterface.php

@@ -8,9 +8,4 @@ interface ItemDocumentInterface extends DocumentInterface
      * @return \Swis\JsonApi\Client\Interfaces\ItemInterface
      */
     public function getData();
-
-    /**
-     * @return array
-     */
-    public function toArray();
 }

src/InvalidResponseDocument.php

@@ -23,6 +23,14 @@ public function getErrors(): ErrorCollection
         return new ErrorCollection();
     }
 
+    /**
+     * @return bool
+     */
+    public function hasErrors(): bool
+    {
+        return false;
+    }
+
     /**
      * @return mixed
      */
@@ -56,10 +64,10 @@ public function getJsonapi()
     }
 
     /**
-     * @return bool
+     * @return array
      */
-    public function hasErrors(): bool
+    public function toArray(): array
     {
-        return false;
+        return [];
     }
 }

src/ItemDocument.php

@@ -4,54 +4,6 @@
 
 use Swis\JsonApi\Client\Interfaces\ItemDocumentInterface;
 
-class ItemDocument extends Document implements ItemDocumentInterface, \JsonSerializable
+class ItemDocument extends Document implements ItemDocumentInterface
 {
-    /**
-     * Specify data which should be serialized to JSON.
-     *
-     * @see  http://php.net/manual/en/jsonserializable.jsonserialize.php
-     *
-     * @return mixed data which can be serialized by <b>json_encode</b>,
-     *               which is a value of any type other than a resource
-     *
-     * @since 5.4.0
-     */
-    public function jsonSerialize()
-    {
-        return $this->toArray();
-    }
-
-    /**
-     * @return array
-     */
-    public function toArray(): array
-    {
-        $document = [];
-
-        if (!empty($this->getLinks())) {
-            $document['links'] = $this->links;
-        }
-
-        if (!empty($this->getData())) {
-            $document['data'] = $this->data->toJsonApiArray();
-        }
-
-        if (!empty($this->getIncluded())) {
-            $document['included'] = $this->getIncluded()->toJsonApiArray();
-        }
-
-        if (!empty($this->getMeta())) {
-            $document['meta'] = $this->meta;
-        }
-
-        if ($this->hasErrors()) {
-            $document['errors'] = $this->errors->toArray();
-        }
-
-        if (!empty($this->getJsonapi())) {
-            $document['jsonapi'] = $this->jsonapi;
-        }
-
-        return $document;
-    }
 }