Add "@internal" annotation to attachTo() (#94)

seriy · f3ath · commit 4fb3c7a30b6f · 2019-09-10T10:16:17.000-07:00
diff --git a/examples/compound_doc.php b/examples/compound_doc.php
@@ -34,6 +34,7 @@
     new SelfLink('http://example.com/comments/5'),
     new ToOne('author', new ResourceIdentifier('people', '2'))
 );
+
 $comment12 = new ResourceObject(
     'comments',
     '12',
diff --git a/src/Attribute.php b/src/Attribute.php
@@ -22,6 +22,7 @@ public function __construct(string $name, $val)
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void
     {
diff --git a/src/EmptyRelationship.php b/src/EmptyRelationship.php
@@ -23,6 +23,7 @@ public function __construct(string $name, RelationshipMember $member, Relationsh
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void
     {
diff --git a/src/Error.php b/src/Error.php
@@ -23,6 +23,7 @@ public function __construct(ErrorMember ...$members)
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void
     {
diff --git a/src/Error/Code.php b/src/Error/Code.php
@@ -21,6 +21,7 @@ public function __construct(string $code)
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void
     {
diff --git a/src/Error/Detail.php b/src/Error/Detail.php
@@ -21,6 +21,7 @@ public function __construct(string $detail)
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void
     {
diff --git a/src/Error/Id.php b/src/Error/Id.php
@@ -21,6 +21,7 @@ public function __construct(string $id)
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void
     {
diff --git a/src/Error/SourceParameter.php b/src/Error/SourceParameter.php
@@ -22,6 +22,7 @@ public function __construct(string $parameter)
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void
     {
diff --git a/src/Error/SourcePointer.php b/src/Error/SourcePointer.php
@@ -19,6 +19,7 @@ public function __construct(string $pointer)
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void
     {
diff --git a/src/Error/Status.php b/src/Error/Status.php
@@ -21,6 +21,7 @@ public function __construct(string $status)
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void
     {
diff --git a/src/Error/Title.php b/src/Error/Title.php
@@ -22,6 +22,7 @@ public function __construct(string $title)
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void
     {
diff --git a/src/ErrorDocument.php b/src/ErrorDocument.php
@@ -12,10 +12,9 @@ final class ErrorDocument implements \JsonSerializable
 {
     private $obj;
 
-    public function __construct(Error $error, ErrorDocumentMember ...$members)
+    public function __construct(ErrorDocumentMember ...$members)
     {
         $this->obj = (object) [];
-        $error->attachTo($this->obj);
         foreach ($members as $member) {
             $member->attachTo($this->obj);
         }
diff --git a/src/Included.php b/src/Included.php
@@ -40,6 +40,7 @@ public function validateLinkage(PrimaryData $data): void
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void
     {
diff --git a/src/Internal/Attachable.php b/src/Internal/Attachable.php
@@ -9,6 +9,7 @@ interface Attachable
 {
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void;
 }
diff --git a/src/JsonApi.php b/src/JsonApi.php
@@ -22,6 +22,7 @@ public function __construct(string $version = '1.0', Meta $meta = null)
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void
     {
diff --git a/src/Link/AboutLink.php b/src/Link/AboutLink.php
@@ -12,6 +12,7 @@ final class AboutLink implements ErrorMember
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void
     {
diff --git a/src/Link/FirstLink.php b/src/Link/FirstLink.php
@@ -12,6 +12,7 @@ final class FirstLink implements PaginationLink
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void
     {
diff --git a/src/Link/LastLink.php b/src/Link/LastLink.php
@@ -12,6 +12,7 @@ final class LastLink implements PaginationLink
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void
     {
diff --git a/src/Link/NextLink.php b/src/Link/NextLink.php
@@ -12,6 +12,7 @@ final class NextLink implements PaginationLink
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void
     {
diff --git a/src/Link/PrevLink.php b/src/Link/PrevLink.php
@@ -12,6 +12,7 @@ final class PrevLink implements PaginationLink
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void
     {
diff --git a/src/Link/RelatedLink.php b/src/Link/RelatedLink.php
@@ -12,6 +12,7 @@ final class RelatedLink implements RelationshipMember
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void
     {
diff --git a/src/Link/SelfLink.php b/src/Link/SelfLink.php
@@ -14,6 +14,7 @@ final class SelfLink implements DataDocumentMember, ResourceMember, Relationship
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void
     {
diff --git a/src/Meta.php b/src/Meta.php
@@ -26,6 +26,10 @@ public function __construct(string $key, $value)
         $this->value = $value;
     }
 
+    /**
+     * @param object $o
+     * @internal
+     */
     public function attachTo($o): void
     {
         child($o, 'meta')->{$this->key} = $this->value;
diff --git a/src/NullData.php b/src/NullData.php
@@ -8,6 +8,7 @@ final class NullData implements PrimaryData
 {
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void
     {
diff --git a/src/PaginatedCollection.php b/src/PaginatedCollection.php
@@ -24,6 +24,7 @@ public function __construct(Pagination $pagination, Collection $collection)
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void
     {
diff --git a/src/Pagination.php b/src/Pagination.php
@@ -20,6 +20,7 @@ public function __construct(PaginationLink ...$links)
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void
     {
diff --git a/src/ResourceCollection.php b/src/ResourceCollection.php
@@ -19,6 +19,7 @@ public function __construct(ResourceObject ...$resources)
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void
     {
diff --git a/src/ResourceIdentifier.php b/src/ResourceIdentifier.php
@@ -35,6 +35,7 @@ public function __construct(string $type, string $id, Meta $meta = null)
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void
     {
@@ -43,6 +44,7 @@ public function attachTo($o): void
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachToCollection($o): void
     {
diff --git a/src/ResourceIdentifierCollection.php b/src/ResourceIdentifierCollection.php
@@ -19,6 +19,7 @@ public function __construct(ResourceIdentifier ...$identifiers)
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void
     {
diff --git a/src/ResourceObject.php b/src/ResourceObject.php
@@ -61,6 +61,7 @@ public function registerIn(array &$registry): void
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void
     {
@@ -77,6 +78,7 @@ public function attachAsIncludedTo($o): void
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachToCollection($o): void
     {
diff --git a/src/ToMany.php b/src/ToMany.php
@@ -29,6 +29,7 @@ public function __construct(string $name, ResourceIdentifierCollection $collecti
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void
     {
diff --git a/src/ToNull.php b/src/ToNull.php
@@ -23,6 +23,7 @@ public function __construct(string $name, ToOneMember ...$members)
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void
     {
diff --git a/src/ToOne.php b/src/ToOne.php
@@ -28,6 +28,7 @@ public function __construct(string $name, ResourceIdentifier $identifier, ToOneM
 
     /**
      * @param object $o
+     * @internal
      */
     public function attachTo($o): void
     {
diff --git a/test/CompoundDocumentTest.php b/test/CompoundDocumentTest.php
@@ -39,6 +39,7 @@ public function testOfficialDocsExample()
             new SelfLink('http://example.com/comments/5'),
             new ToOne('author', new ResourceIdentifier('people', '2'))
         );
+
         $comment12 = new ResourceObject(
             'comments',
             '12',
diff --git a/test/benchmarks/compound10k.php b/test/benchmarks/compound10k.php
@@ -49,6 +49,7 @@
         new SelfLink('http://example.com/comments/5'),
         new ToOne('author', new ResourceIdentifier('people', '2'))
     );
+
     $comment12 = new ResourceObject(
         'comments',
         '12',

Original file line number	Diff line number	Diff line change
`@@ -22,6 +22,7 @@ public function __construct(string $name, $val)`
`22`	`22`
`23`	`23`	`/**`
`24`	`24`	`* @param object $o`
	`25`	`+ * @internal`
`25`	`26`	`*/`
`26`	`27`	`public function attachTo($o): void`
`27`	`28`	`{`
Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@ public function __construct(string $name, RelationshipMember $member, Relationsh`
`23`	`23`
`24`	`24`	`/**`
`25`	`25`	`* @param object $o`
	`26`	`+ * @internal`
`26`	`27`	`*/`
`27`	`28`	`public function attachTo($o): void`
`28`	`29`	`{`
Original file line number	Diff line number	Diff line change
`@@ -21,6 +21,7 @@ public function __construct(string $code)`
`21`	`21`
`22`	`22`	`/**`
`23`	`23`	`* @param object $o`
	`24`	`+ * @internal`
`24`	`25`	`*/`
`25`	`26`	`public function attachTo($o): void`
`26`	`27`	`{`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@ public function __construct(string $pointer)`
`19`	`19`
`20`	`20`	`/**`
`21`	`21`	`* @param object $o`
	`22`	`+ * @internal`
`22`	`23`	`*/`
`23`	`24`	`public function attachTo($o): void`
`24`	`25`	`{`
Original file line number	Diff line number	Diff line change
`@@ -12,10 +12,9 @@ final class ErrorDocument implements \JsonSerializable`
`12`	`12`	`{`
`13`	`13`	`private $obj;`
`14`	`14`
`15`		`- public function __construct(Error $error, ErrorDocumentMember ...$members)`
	`15`	`+ public function __construct(ErrorDocumentMember ...$members)`
`16`	`16`	`{`
`17`	`17`	`$this->obj = (object) [];`
`18`		`- $error->attachTo($this->obj);`
`19`	`18`	`foreach ($members as $member) {`
`20`	`19`	`$member->attachTo($this->obj);`
`21`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,6 +40,7 @@ public function validateLinkage(PrimaryData $data): void`
`40`	`40`
`41`	`41`	`/**`
`42`	`42`	`* @param object $o`
	`43`	`+ * @internal`
`43`	`44`	`*/`
`44`	`45`	`public function attachTo($o): void`
`45`	`46`	`{`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@ interface Attachable`
`9`	`9`	`{`
`10`	`10`	`/**`
`11`	`11`	`* @param object $o`
	`12`	`+ * @internal`
`12`	`13`	`*/`
`13`	`14`	`public function attachTo($o): void;`
`14`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@ final class AboutLink implements ErrorMember`
`12`	`12`
`13`	`13`	`/**`
`14`	`14`	`* @param object $o`
	`15`	`+ * @internal`
`15`	`16`	`*/`
`16`	`17`	`public function attachTo($o): void`
`17`	`18`	`{`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@ final class FirstLink implements PaginationLink`
`12`	`12`
`13`	`13`	`/**`
`14`	`14`	`* @param object $o`
	`15`	`+ * @internal`
`15`	`16`	`*/`
`16`	`17`	`public function attachTo($o): void`
`17`	`18`	`{`
Original file line number	Diff line number	Diff line change
`@@ -12,6 +12,7 @@ final class LastLink implements PaginationLink`
`12`	`12`
`13`	`13`	`/**`
`14`	`14`	`* @param object $o`
	`15`	`+ * @internal`
`15`	`16`	`*/`
`16`	`17`	`public function attachTo($o): void`
`17`	`18`	`{`