Merge pull request #25 from phpro/psalm-types

Add psalm docs

Author: veewee

src/Transformer/ApiProblemExceptionTransformer.php

@@ -9,6 +9,9 @@
 use Phpro\ApiProblemBundle\Exception\ApiProblemHttpException;
 use Throwable;
 
+/**
+ * @template-implements ExceptionTransformerInterface<ApiProblemException|ApiProblemHttpException>
+ */
 class ApiProblemExceptionTransformer implements ExceptionTransformerInterface
 {
     /**

src/Transformer/Chain.php

@@ -8,6 +8,9 @@
 use Phpro\ApiProblem\Http\ExceptionApiProblem;
 use Throwable;
 
+/**
+ * @template-implements ExceptionTransformerInterface<Throwable>
+ */
 class Chain implements ExceptionTransformerInterface
 {
     /**

src/Transformer/ExceptionTransformerInterface.php

@@ -7,9 +7,18 @@
 use Phpro\ApiProblem\ApiProblemInterface;
 use Throwable;
 
+/**
+ * @template T of \Throwable
+ */
 interface ExceptionTransformerInterface
 {
+    /**
+     * @param T $exception
+     */
     public function transform(Throwable $exception): ApiProblemInterface;
 
+    /**
+     * @psalm-assert-if-true T $exception
+     */
     public function accepts(Throwable $exception): bool;
 }

src/Transformer/HttpExceptionTransformer.php

@@ -9,6 +9,9 @@
 use Symfony\Component\HttpKernel\Exception\HttpException;
 use Throwable;
 
+/**
+ * @template-implements ExceptionTransformerInterface<HttpException>
+ */
 class HttpExceptionTransformer implements ExceptionTransformerInterface
 {
     /**

src/Transformer/SecurityExceptionTransformer.php

@@ -11,6 +11,9 @@
 use Symfony\Component\Security\Core\Exception\ExceptionInterface as SecurityException;
 use Throwable;
 
+/**
+ * @template-implements ExceptionTransformerInterface<SecurityException>
+ */
 class SecurityExceptionTransformer implements ExceptionTransformerInterface
 {
     public function transform(Throwable $exception): ApiProblemInterface