Merge pull request #85 from lode/strict-typing

Author: lode

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 = [