Simplification, Formatting, Performance (#83)

json-api-php · Mar 3, 2018 · 42d32f3 · 42d32f3
1 parent 0ffb320
commit 42d32f3
Show file tree

Hide file tree

Showing 40 changed files with 277 additions and 276 deletions.
diff --git a/examples/compound_doc.php b/examples/compound_doc.php
@@ -7,8 +7,9 @@
 use JsonApiPhp\JsonApi\Link\NextLink;
 use JsonApiPhp\JsonApi\Link\RelatedLink;
 use JsonApiPhp\JsonApi\Link\SelfLink;
-use JsonApiPhp\JsonApi\PaginatedResourceCollection;
+use JsonApiPhp\JsonApi\PaginatedCollection;
 use JsonApiPhp\JsonApi\Pagination;
+use JsonApiPhp\JsonApi\ResourceCollection;
 use JsonApiPhp\JsonApi\ResourceIdentifier;
 use JsonApiPhp\JsonApi\ResourceIdentifierCollection;
 use JsonApiPhp\JsonApi\ResourceObject;
@@ -39,34 +40,36 @@
     '12',
     new Attribute('body', 'I like XML better'),
     new SelfLink('http://example.com/comments/12'),
-    new ToOne('author', $dan->toIdentifier())
+    new ToOne('author', $dan->identifier())
 );
 
 $document = new CompoundDocument(
-    new PaginatedResourceCollection(
+    new PaginatedCollection(
         new Pagination(
             new NextLink('http://example.com/articles?page[offset]=2'),
             new LastLink('http://example.com/articles?page[offset]=10')
         ),
-        new ResourceObject(
-            'articles',
-            '1',
-            new Attribute('title', 'JSON API paints my bikeshed!'),
-            new SelfLink('http://example.com/articles/1'),
-            new ToOne(
-                'author',
-                $dan->toIdentifier(),
-                new SelfLink('http://example.com/articles/1/relationships/author'),
-                new RelatedLink('http://example.com/articles/1/author')
-            ),
-            new ToMany(
-                'comments',
-                new ResourceIdentifierCollection(
-                    $comment05->toIdentifier(),
-                    $comment12->toIdentifier()
+        new ResourceCollection(
+            new ResourceObject(
+                'articles',
+                '1',
+                new Attribute('title', 'JSON API paints my bikeshed!'),
+                new SelfLink('http://example.com/articles/1'),
+                new ToOne(
+                    'author',
+                    $dan->identifier(),
+                    new SelfLink('http://example.com/articles/1/relationships/author'),
+                    new RelatedLink('http://example.com/articles/1/author')
                 ),
-                new SelfLink('http://example.com/articles/1/relationships/comments'),
-                new RelatedLink('http://example.com/articles/1/comments')
+                new ToMany(
+                    'comments',
+                    new ResourceIdentifierCollection(
+                        $comment05->identifier(),
+                        $comment12->identifier()
+                    ),
+                    new SelfLink('http://example.com/articles/1/relationships/comments'),
+                    new RelatedLink('http://example.com/articles/1/comments')
+                )
             )
         )
     ),

diff --git a/src/Attribute.php b/src/Attribute.php
@@ -5,6 +5,9 @@
 use JsonApiPhp\JsonApi\Internal\ResourceField;
 use JsonApiPhp\JsonApi\Internal\ResourceFieldTrait;
 
+/**
+ * @see http://jsonapi.org/format/#document-resource-object-attributes
+ */
 final class Attribute implements ResourceField
 {
     use ResourceFieldTrait;
@@ -17,7 +20,7 @@ public function __construct(string $name, $val)
         $this->val = $val;
     }
 
-    public function attachTo(object $o)
+    public function attachTo(object $o): void
     {
         child($o, 'attributes')->{$this->name} = $this->val;
     }

diff --git a/src/CompoundDocument.php b/src/CompoundDocument.php
@@ -5,6 +5,10 @@
 use JsonApiPhp\JsonApi\Internal\DataDocumentMember;
 use JsonApiPhp\JsonApi\Internal\PrimaryData;
 
+/**
+ * A Document with the "included" member
+ * @see http://jsonapi.org/format/#document-compound-documents
+ */
 final class CompoundDocument implements \JsonSerializable
 {
     private $doc;

diff --git a/src/DataDocument.php b/src/DataDocument.php
@@ -5,6 +5,10 @@
 use JsonApiPhp\JsonApi\Internal\DataDocumentMember;
 use JsonApiPhp\JsonApi\Internal\PrimaryData;
 
+/**
+ * A Document containing the "data" member
+ * @see http://jsonapi.org/format/#document-top-level
+ */
 final class DataDocument implements \JsonSerializable
 {
     private $value;

diff --git a/src/Error.php b/src/Error.php
@@ -5,6 +5,10 @@
 use JsonApiPhp\JsonApi\Internal\ErrorDocumentMember;
 use JsonApiPhp\JsonApi\Internal\ErrorMember;
 
+/**
+ * An Error Object
+ * @see
+ */
 final class Error implements ErrorDocumentMember
 {
     private $error;
@@ -17,7 +21,7 @@ public function __construct(ErrorMember ...$members)
         }
     }
 
-    public function attachTo(object $o)
+    public function attachTo(object $o): void
     {
         $o->errors[] = $this->error;
     }

diff --git a/src/ErrorDocument.php b/src/ErrorDocument.php
@@ -4,21 +4,25 @@
 
 use JsonApiPhp\JsonApi\Internal\ErrorDocumentMember;
 
+/**
+ * A Document containing an array of Error objects
+ * @see http://jsonapi.org/format/#document-top-level
+ */
 final class ErrorDocument implements \JsonSerializable
 {
-    private $doc;
+    private $obj;
 
     public function __construct(Error $error, ErrorDocumentMember ...$members)
     {
-        $this->doc = (object) [];
-        $error->attachTo($this->doc);
+        $this->obj = (object) [];
+        $error->attachTo($this->obj);
         foreach ($members as $member) {
-            $member->attachTo($this->doc);
+            $member->attachTo($this->obj);
         }
     }
 
     public function jsonSerialize()
     {
-        return $this->doc;
+        return $this->obj;
     }
 }
diff --git a/src/Included.php b/src/Included.php
@@ -3,7 +3,6 @@
 namespace JsonApiPhp\JsonApi;
 
 use JsonApiPhp\JsonApi\Internal\Attachable;
-use JsonApiPhp\JsonApi\Internal\IdentifierRegistry;
 use JsonApiPhp\JsonApi\Internal\PrimaryData;
 
 final class Included implements Attachable
@@ -13,34 +12,33 @@ final class Included implements Attachable
      */
     private $resources = [];
 
-    private $ids;
+    private $identifiers = [];
 
     public function __construct(ResourceObject ...$resources)
     {
-        $this->ids = new IdentifierRegistry();
         foreach ($resources as $resource) {
-            $string_id = $resource->key();
-            if (isset($this->resources[$string_id])) {
-                throw new \LogicException("Resource $string_id is already included");
+            $key = $resource->key();
+            if (isset($this->resources[$key])) {
+                throw new \LogicException("Resource $resource is already included");
             }
-            $this->resources[$string_id] = $resource;
-            $resource->registerIn($this->ids);
+            $this->resources[$key] = $resource;
+            $resource->registerIn($this->identifiers);
         }
     }
 
     public function validateLinkage(PrimaryData $data): void
     {
-        $dataRegistry = new IdentifierRegistry();
-        $data->registerIn($dataRegistry);
+        $registry = [];
+        $data->registerIn($registry);
         foreach ($this->resources as $resource) {
-            if ($dataRegistry->has($resource->key()) || $this->ids->has($resource->key())) {
+            if (isset($registry[$resource->key()]) || isset($this->identifiers[$resource->key()])) {
                 continue;
             }
-            throw new \LogicException('Full linkage required for '.$resource->key());
+            throw new \LogicException('Full linkage required for '.$resource);
         }
     }
 
-    public function attachTo(object $o)
+    public function attachTo(object $o): void
     {
         foreach ($this->resources as $resource) {
             $resource->attachAsIncludedTo($o);

diff --git a/src/Internal/Attachable.php b/src/Internal/Attachable.php
@@ -7,5 +7,5 @@
  */
 interface Attachable
 {
-    public function attachTo(object $o);
+    public function attachTo(object $o): void;
 }
diff --git a/src/Internal/Collection.php b/src/Internal/Collection.php
@@ -0,0 +1,7 @@
+<?php declare(strict_types=1);
+
+namespace JsonApiPhp\JsonApi\Internal;
+
+interface Collection extends PrimaryData
+{
+}
diff --git a/src/Internal/Identifier.php b/src/Internal/Identifier.php
@@ -7,5 +7,9 @@
  */
 interface Identifier
 {
-    public function registerIn(IdentifierRegistry $registry);
+    /**
+     * @internal
+     * @param array $registry
+     */
+    public function registerIn(array &$registry): void;
 }
diff --git a/src/Internal/IdentifierRegistry.php b/src/Internal/IdentifierRegistry.php
diff --git a/src/Internal/IdentityTrait.php b/src/Internal/IdentityTrait.php
diff --git a/src/Internal/LinkTrait.php b/src/Internal/LinkTrait.php
@@ -1,5 +1,4 @@
-<?php
-declare(strict_types=1);
+<?php declare(strict_types=1);
 
 namespace JsonApiPhp\JsonApi\Internal;
 

diff --git a/src/Internal/ToManyMember.php b/src/Internal/ToManyMember.php
@@ -0,0 +1,7 @@
+<?php declare(strict_types=1);
+
+namespace JsonApiPhp\JsonApi\Internal;
+
+interface ToManyMember extends ToOneMember
+{
+}
diff --git a/src/Internal/RelationshipMember.php → src/Internal/ToOneMember.php b/src/Internal/RelationshipMember.php → src/Internal/ToOneMember.php
@@ -5,6 +5,6 @@
 /**
  * @internal
  */
-interface RelationshipMember extends Attachable
+interface ToOneMember extends Attachable
 {
 }
diff --git a/src/JsonApi.php b/src/JsonApi.php
@@ -8,20 +8,20 @@
 
 final class JsonApi implements MetaDocumentMember, DataDocumentMember, ErrorDocumentMember
 {
-    private $jsonapi;
+    private $obj;
 
     public function __construct(string $version = '1.0', Meta $meta = null)
     {
-        $this->jsonapi = (object) [
+        $this->obj = (object) [
             'version' => $version,
         ];
         if ($meta) {
-            $meta->attachTo($this->jsonapi);
+            $meta->attachTo($this->obj);
         }
     }
 
-    public function attachTo(object $o)
+    public function attachTo(object $o): void
     {
-        $o->jsonapi = $this->jsonapi;
+        $o->jsonapi = $this->obj;
     }
 }
diff --git a/src/Link/AboutLink.php b/src/Link/AboutLink.php
@@ -10,7 +10,7 @@ final class AboutLink implements ErrorMember
 {
     use LinkTrait;
 
-    public function attachTo(object $o)
+    public function attachTo(object $o): void
     {
         child($o, 'links')->about = $this->link;
     }

diff --git a/src/Link/FirstLink.php b/src/Link/FirstLink.php
@@ -10,7 +10,7 @@ final class FirstLink implements PaginationLink
 {
     use LinkTrait;
 
-    public function attachTo(object $o)
+    public function attachTo(object $o): void
     {
         child($o, 'links')->first = $this->link;
     }

diff --git a/src/Link/LastLink.php b/src/Link/LastLink.php
@@ -10,7 +10,7 @@ final class LastLink implements PaginationLink
 {
     use LinkTrait;
 
-    public function attachTo(object $o)
+    public function attachTo(object $o): void
     {
         child($o, 'links')->last = $this->link;
     }

diff --git a/src/Link/NextLink.php b/src/Link/NextLink.php
@@ -10,7 +10,7 @@ final class NextLink implements PaginationLink
 {
     use LinkTrait;
 
-    public function attachTo(object $o)
+    public function attachTo(object $o): void
     {
         child($o, 'links')->next = $this->link;
     }

diff --git a/src/Link/PrevLink.php b/src/Link/PrevLink.php
@@ -10,7 +10,7 @@ final class PrevLink implements PaginationLink
 {
     use LinkTrait;
 
-    public function attachTo(object $o)
+    public function attachTo(object $o): void
     {
         child($o, 'links')->prev = $this->link;
     }