Add strict type hints

README.md

@@ -175,11 +175,11 @@ use alsvanzelf\jsonapi\ResourceDocument;
 use alsvanzelf\jsonapi\interfaces\ExtensionInterface;
 
 class ExampleExtension implements ExtensionInterface {
-	public function getOfficialLink() {
+	public function getOfficialLink(): string {
 		return 'https://example.org/extension-documentation';
 	}
 
-	public function getNamespace() {
+	public function getNamespace(): string {
 		return 'foo';
 	}
 }

UPGRADE_2_TO_3.md

@@ -0,0 +1,43 @@
+# Upgrade from library v2 to v3
+
+## Checking links, ...
+
+Objects more often use uninitialized properties. `has*()` helper methods have been added to support the new flow.
+
+- `$object->links` to `if ($object->hasLinks()) $object->links`
+
+## Interfaces
+
+When extending interfaces, you'll have to add method argument types and return types.
+
+Check [all interfaces](/src/interfaces) for the correct typing.
+
+## Enums
+
+Content types:
+- `Document::CONTENT_TYPE_OFFICIAL` to `ContentTypeEnum::Official`
+- `Document::CONTENT_TYPE_DEBUG` to `ContentTypeEnum::Debug`
+- `Document::CONTENT_TYPE_JSONP` to `ContentTypeEnum::Jsonp`
+
+Jsonapi versions:
+- `Document::JSONAPI_VERSION_1_0` to `JsonapiVersionEnum::V_1_0`
+- `Document::JSONAPI_VERSION_1_1` to `JsonapiVersionEnum::V_1_1`
+- `Document::JSONAPI_VERSION_LATEST` to `JsonapiVersionEnum::Latest`
+
+Document levels:
+- `Document::LEVEL_ROOT` to `DocumentLevelEnum::Root`
+- `Document::LEVEL_JSONAPI` to `DocumentLevelEnum::Jsonapi`
+- `Document::LEVEL_Resource` to `DocumentLevelEnum::Resource`
+
+Sorting orders:
+- `RequestParser->getSortFields()` returns a `SortOrderEnum` instead of `string` for the `order` field
+
+Relationship types:
+- `RelationshipObject::TO_ONE` to `RelationshipTypeEnum::ToOne`
+- `RelationshipObject::TO_MANY` to `RelationshipTypeEnum::ToMany`
+
+## Internal
+
+Enums:
+- `RequestParser::SORT_*` to `SortOrderEnum::*`
+- `Validator::OBJECT_CONTAINER_*` to `ObjectContainerEnum::*`

examples/atomic_operations_extension.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 use alsvanzelf\jsonapi\objects\ResourceObject;
 use alsvanzelf\jsonapi\extensions\AtomicOperationsDocument;
 

examples/bootstrap_examples.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 use alsvanzelf\jsonapi\Document;
 use alsvanzelf\jsonapi\ResourceDocument;
 use alsvanzelf\jsonapi\interfaces\ExtensionInterface;
@@ -110,11 +112,11 @@ class ExampleVersionExtension implements ExtensionInterface {
 	 * the required method
 	 */
 
-	public function getOfficialLink() {
+	public function getOfficialLink(): string {
 		return 'https://jsonapi.org/format/1.1/#extension-rules';
 	}
 
-	public function getNamespace() {
+	public function getNamespace(): string {
 		return 'version';
 	}
 
@@ -141,7 +143,7 @@ class ExampleTimestampsProfile implements ProfileInterface {
 	 * the required method
 	 */
 
-	public function getOfficialLink() {
+	public function getOfficialLink(): string {
 		return 'https://jsonapi.org/recommendations/#authoring-profiles';
 	}
 

examples/collection.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 use alsvanzelf\jsonapi\CollectionDocument;
 use alsvanzelf\jsonapi\objects\ResourceObject;
 

examples/collection_canonical.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 use alsvanzelf\jsonapi\CollectionDocument;
 use alsvanzelf\jsonapi\objects\ResourceObject;
 

examples/cursor_pagination_profile.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 use alsvanzelf\jsonapi\CollectionDocument;
 use alsvanzelf\jsonapi\objects\ResourceObject;
 use alsvanzelf\jsonapi\profiles\CursorPaginationProfile;

examples/errors_all_options.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 use alsvanzelf\jsonapi\ErrorsDocument;
 use alsvanzelf\jsonapi\objects\ErrorObject;
 

examples/errors_exception_native.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 use alsvanzelf\jsonapi\ErrorsDocument;
 
 require 'bootstrap_examples.php';

examples/extension.php

@@ -1,7 +1,9 @@
 <?php
 
-use alsvanzelf\jsonapi\Document;
+declare(strict_types=1);
+
 use alsvanzelf\jsonapi\ResourceDocument;
+use alsvanzelf\jsonapi\enums\ContentTypeEnum;
 use alsvanzelf\jsonapi\helpers\Converter;
 
 require 'bootstrap_examples.php';
@@ -28,7 +30,7 @@
  * get the json
  */
 
-$contentType = Converter::prepareContentType(Document::CONTENT_TYPE_OFFICIAL, [$extension], []);
+$contentType = Converter::prepareContentType(ContentTypeEnum::Official, [$extension], []);
 echo '<code>Content-Type: '.$contentType.'</code>'.PHP_EOL;
 
 $options = [

examples/meta_only.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 use alsvanzelf\jsonapi\MetaDocument;
 
 require 'bootstrap_examples.php';

examples/null_values.php

@@ -1,6 +1,9 @@
 <?php
 
+declare(strict_types=1);
+
 use alsvanzelf\jsonapi\ResourceDocument;
+use alsvanzelf\jsonapi\enums\RelationshipTypeEnum;
 use alsvanzelf\jsonapi\objects\LinkObject;
 use alsvanzelf\jsonapi\objects\RelationshipObject;
 
@@ -22,8 +25,8 @@
 
 // show a relationship is not set
 $document->addRelationship('bar', null);
-$document->addRelationshipObject('baz', new RelationshipObject(RelationshipObject::TO_ONE));
-$document->addRelationshipObject('baf', new RelationshipObject(RelationshipObject::TO_MANY));
+$document->addRelationshipObject('baz', new RelationshipObject(RelationshipTypeEnum::ToOne));
+$document->addRelationshipObject('baf', new RelationshipObject(RelationshipTypeEnum::ToMany));
 
 /**
  * sending the response

examples/output.php

@@ -1,7 +1,9 @@
 <?php
 
-use alsvanzelf\jsonapi\Document;
+declare(strict_types=1);
+
 use alsvanzelf\jsonapi\MetaDocument;
+use alsvanzelf\jsonapi\enums\ContentTypeEnum;
 
 require 'bootstrap_examples.php';
 
@@ -73,4 +75,4 @@
 echo '<pre>';
 $document->sendResponse($options);
 echo '</pre>';
-echo '<p><em>Also sends http status code ('.$document->getHttpStatusCode().') and headers: [Content-Type: '.Document::CONTENT_TYPE_OFFICIAL.']</em></p>';
+echo '<p><em>Also sends http status code ('.$document->getHttpStatusCode().') and headers: [Content-Type: '.ContentTypeEnum::Official->value.']</em></p>';

examples/profile.php

@@ -1,7 +1,9 @@
 <?php
 
-use alsvanzelf\jsonapi\Document;
+declare(strict_types=1);
+
 use alsvanzelf\jsonapi\ResourceDocument;
+use alsvanzelf\jsonapi\enums\ContentTypeEnum;
 use alsvanzelf\jsonapi\helpers\Converter;
 
 require 'bootstrap_examples.php';
@@ -30,7 +32,7 @@
  * get the json
  */
 
-$contentType = Converter::prepareContentType(Document::CONTENT_TYPE_OFFICIAL, [], [$profile]);
+$contentType = Converter::prepareContentType(ContentTypeEnum::Official, [], [$profile]);
 echo '<code>Content-Type: '.$contentType.'</code>'.PHP_EOL;
 
 $options = [

examples/relationship_to_many_document.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 use alsvanzelf\jsonapi\CollectionDocument;
 
 require 'bootstrap_examples.php';

examples/relationship_to_one_document.php

@@ -1,7 +1,9 @@
 <?php
 
-use alsvanzelf\jsonapi\Document;
+declare(strict_types=1);
+
 use alsvanzelf\jsonapi\ResourceDocument;
+use alsvanzelf\jsonapi\enums\DocumentLevelEnum;
 
 require 'bootstrap_examples.php';
 
@@ -11,7 +13,7 @@
 
 $relationshipDocument = new ResourceDocument('author', 12);
 
-$relationshipDocument->setSelfLink('/articles/1/relationship/author', $meta=[], $level=Document::LEVEL_ROOT);
+$relationshipDocument->setSelfLink('/articles/1/relationship/author', $meta=[], $level=DocumentLevelEnum::Root);
 $relationshipDocument->addLink('related', '/articles/1/author');
 
 /**

examples/relationships.php

@@ -1,7 +1,10 @@
 <?php
 
+declare(strict_types=1);
+
 use alsvanzelf\jsonapi\CollectionDocument;
 use alsvanzelf\jsonapi\ResourceDocument;
+use alsvanzelf\jsonapi\enums\RelationshipTypeEnum;
 use alsvanzelf\jsonapi\objects\RelationshipObject;
 use alsvanzelf\jsonapi\objects\ResourceObject;
 
@@ -45,7 +48,7 @@
  * to-many relationship, one-by-one
  */
 
-$relationshipObject = new RelationshipObject($type=RelationshipObject::TO_MANY);
+$relationshipObject = new RelationshipObject($type=RelationshipTypeEnum::ToMany);
 $relationshipObject->addResource($friend1Resource);
 $relationshipObject->addResource($friend2Resource);
 
@@ -65,7 +68,7 @@
  * to-many relationship, different types
  */
 
-$relationshipObject = new RelationshipObject($type=RelationshipObject::TO_MANY);
+$relationshipObject = new RelationshipObject($type=RelationshipTypeEnum::ToMany);
 $relationshipObject->addResource($ship1Resource);
 $relationshipObject->addResource($dockResource);
 

examples/request_superglobals.php

@@ -1,6 +1,8 @@
 <?php
 
-use alsvanzelf\jsonapi\Document;
+declare(strict_types=1);
+
+use alsvanzelf\jsonapi\enums\ContentTypeEnum;
 use alsvanzelf\jsonapi\helpers\RequestParser;
 
 require 'bootstrap_examples.php';
@@ -44,7 +46,7 @@
 $_SERVER['REQUEST_SCHEME'] = 'https';
 $_SERVER['HTTP_HOST']      = 'example.org';
 $_SERVER['REQUEST_URI']    = '/user/42?'.http_build_query($_GET);
-$_SERVER['CONTENT_TYPE']   = Document::CONTENT_TYPE_OFFICIAL;
+$_SERVER['CONTENT_TYPE']   = ContentTypeEnum::Official->value;
 
 /**
  * parsing the request

examples/resource_human_api.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 use alsvanzelf\jsonapi\ResourceDocument;
 use alsvanzelf\jsonapi\objects\AttributesObject;
 use alsvanzelf\jsonapi\objects\LinksObject;

examples/resource_links.php

@@ -1,7 +1,9 @@
 <?php
 
-use alsvanzelf\jsonapi\Document;
+declare(strict_types=1);
+
 use alsvanzelf\jsonapi\ResourceDocument;
+use alsvanzelf\jsonapi\enums\DocumentLevelEnum;
 
 require 'bootstrap_examples.php';
 
@@ -13,13 +15,13 @@
  */
 $document = ResourceDocument::fromObject($userEntity, $type='user', $userEntity->id);
 
-$selfResourceMeta = ['level' => Document::LEVEL_RESOURCE];
-$partnerMeta      = ['level' => Document::LEVEL_RESOURCE];
-$redirectMeta     = ['level' => Document::LEVEL_ROOT];
+$selfResourceMeta = ['level' => DocumentLevelEnum::Resource->name];
+$partnerMeta      = ['level' => DocumentLevelEnum::Resource->name];
+$redirectMeta     = ['level' => DocumentLevelEnum::Root->name];
 
 $document->setSelfLink('/user/42',        $selfResourceMeta);
-$document->addLink('partner',  '/user/1', $partnerMeta,  $level=Document::LEVEL_RESOURCE);
-$document->addLink('redirect', '/login',  $redirectMeta, $level=Document::LEVEL_ROOT);
+$document->addLink('partner',  '/user/1', $partnerMeta,  $level=DocumentLevelEnum::Resource);
+$document->addLink('redirect', '/login',  $redirectMeta, $level=DocumentLevelEnum::Root);
 
 /**
  * sending the response

examples/resource_nested_relations.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 use alsvanzelf\jsonapi\ResourceDocument;
 use alsvanzelf\jsonapi\objects\ResourceObject;
 

examples/resource_spec_api.php

@@ -1,6 +1,9 @@
 <?php
 
+declare(strict_types=1);
+
 use alsvanzelf\jsonapi\ResourceDocument;
+use alsvanzelf\jsonapi\enums\RelationshipTypeEnum;
 use alsvanzelf\jsonapi\objects\AttributesObject;
 use alsvanzelf\jsonapi\objects\LinksObject;
 use alsvanzelf\jsonapi\objects\MetaObject;
@@ -41,7 +44,7 @@
 $resource->setType('user');
 $resource->setAttributesObject($attributes42);
 
-$relationship = new RelationshipObject(RelationshipObject::TO_ONE);
+$relationship = new RelationshipObject(RelationshipTypeEnum::ToOne);
 $relationship->setResource($resource);
 $relationships = new RelationshipsObject();
 $relationships->addRelationshipObject('friend', $relationship);

examples/status_only.php

@@ -1,5 +1,7 @@
 <?php
 
+declare(strict_types=1);
+
 use alsvanzelf\jsonapi\MetaDocument;
 
 require 'bootstrap_examples.php';

phpstan.neon

@@ -6,6 +6,9 @@ parameters:
 		- tests/
 		- examples/
 
+	typeAliases:
+		PHPStanTypeAlias_InternalOptions: 'array<string, bool|int|null|\alsvanzelf\jsonapi\enums\ContentTypeEnum>'
+
 	treatPhpDocTypesAsCertain: false
 
 	strictRules: