Add generic type hints

This allows type-hinting the api methods parameters and result by using generics.
usox · Oct 31, 2023 · a1e4cf0 · a1e4cf0
1 parent e1397ab
commit a1e4cf0
Show file tree

Hide file tree

Showing 5 changed files with 60 additions and 44 deletions.
diff --git a/composer.lock b/composer.lock
diff --git a/example/index.php b/example/index.php
@@ -9,7 +9,14 @@
 
 require_once __DIR__ . '/../vendor/autoload.php';
 
-// API Handler which actually contains the business logic
+/**
+ * API Handler which actually contains the business logic
+ *
+ * @implements ApiMethodInterface<
+ *  object&stdClass,
+ *  array{beer_style_list: list<string>}
+ * >
+ */
 final class BeerlistMethod implements ApiMethodInterface
 {
     public function handle(

diff --git a/phpunit.xml.dist b/phpunit.xml.dist
@@ -4,7 +4,10 @@
          backupGlobals="true"
          bootstrap="tests/bootstrap.php"
          colors="true"
-         cacheDirectory="build/.phpunit.cache">
+         cacheDirectory="build/.phpunit.cache"
+         displayDetailsOnTestsThatTriggerDeprecations="true"
+         displayDetailsOnTestsThatTriggerWarnings="true"
+>
   <coverage/>
   <source>
     <include>

diff --git a/src/Contract/ApiMethodInterface.php b/src/Contract/ApiMethodInterface.php
@@ -5,23 +5,26 @@
 namespace Usox\JsonSchemaApi\Contract;
 
 use Psr\Http\Message\ServerRequestInterface;
-use stdClass;
 use Usox\JsonSchemaApi\Exception\ApiMethodException;
 
+/**
+ * @template TParameter of object
+ * @template TResult of array
+ */
 interface ApiMethodInterface
 {
     /**
      * This method contains the business logic of the api method
      *
-     * @param stdClass $parameter The method parameter as described in the schema
+     * @param TParameter $parameter The method parameter as described in the schema
      *
-     * @return array<mixed, mixed> The api method response
+     * @return TResult The api method response
      *
      * @throws ApiMethodException
      */
     public function handle(
         ServerRequestInterface $request,
-        stdClass $parameter
+        object $parameter
     ): array;
 
     /**

diff --git a/src/Contract/MethodProviderInterface.php b/src/Contract/MethodProviderInterface.php
@@ -9,6 +9,9 @@
  */
 interface MethodProviderInterface
 {
+    /**
+     * @return null|ApiMethodInterface<object, array<mixed>>
+     */
     public function lookup(
         string $methodName
     ): ?ApiMethodInterface;