Merge pull request #320 from cakephp/phpstan

Improve type declarations

Author: markstory

.phive/phars.xml

@@ -1,4 +1,4 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phive xmlns="https://phar.io/phive">
-  <phar name="phpstan" version="2.1.33" installed="2.1.33" location="./tools/phpstan" copy="false"/>
+  <phar name="phpstan" version="2.1.40" installed="2.1.40" location="./tools/phpstan" copy="false"/>
 </phive>

phpstan-baseline.neon

@@ -1,11 +1,5 @@
-includes:
-	- phpstan-baseline.neon
-
 parameters:
 	level: 8
 	treatPhpDocTypesAsCertain: false
 	paths:
 		- src/
-	ignoreErrors:
-			- identifier: missingType.generics
-			- identifier: missingType.iterableValue

phpstan.neon

@@ -147,6 +147,7 @@ protected function getCanHandler(mixed $policy, string $action): Closure
             new MissingMethodException([$method, $action, get_class($policy)]),
         );
 
+        /** @phpstan-ignore callable.nonCallable */
         return [$policy, $method](...);
     }
 
@@ -167,6 +168,7 @@ protected function getScopeHandler(mixed $policy, string $action): Closure
             new MissingMethodException([$method, $action, get_class($policy)]),
         );
 
+        /** @phpstan-ignore callable.nonCallable */
         return [$policy, $method](...);
     }
 

src/AuthorizationService.php

@@ -118,7 +118,7 @@ public function canResult(mixed $resource, ?string $action = null): ResultInterf
      * @param mixed $resource The resource to check authorization on.
      * @param string|null $action The action to check authorization for.
      * @param string $method The method to use, either "can" or "canResult".
-     * @return \Authorization\Policy\ResultInterface|bool
+     * @return ($method is 'can' ? bool : \Authorization\Policy\ResultInterface)
      */
     protected function performCheck(
         mixed $resource,

src/Controller/Component/AuthorizationComponent.php

@@ -42,7 +42,7 @@ class ForbiddenException extends Exception
      * Constructor
      *
      * @param \Authorization\Policy\ResultInterface|null $result Policy check result.
-     * @param array|string $message Either the string of the error message, or an array of attributes
+     * @param array<string>|string $message Either the string of the error message, or an array of attributes
      *   that are made available in the view, and sprintf()'d into Exception::$_messageTemplate
      * @param int|null $code The code of the error, is also the HTTP status code for the error.
      * @param \Throwable|null $previous the previous exception.

src/Exception/ForbiddenException.php

@@ -25,13 +25,6 @@
 
 class Identity extends IdentityDecorator implements AuthenIdentityInterface
 {
-    /**
-     * Identity data
-     *
-     * @var \Authentication\IdentityInterface
-     */
-    protected ArrayAccess|array $identity;
-
     /**
      * Constructor
      *
@@ -51,6 +44,8 @@ public function __construct(AuthorizationServiceInterface $service, AuthenIdenti
      */
     public function getIdentifier(): string|int|array|null
     {
+        assert($this->identity instanceof AuthenIdentityInterface);
+
         return $this->identity->getIdentifier();
     }
 
@@ -59,6 +54,8 @@ public function getIdentifier(): string|int|array|null
      */
     public function getOriginalData(): ArrayAccess|array
     {
+        assert($this->identity instanceof AuthenIdentityInterface);
+
         return $this->identity->getOriginalData();
     }
 }

src/Identity.php

@@ -33,7 +33,7 @@ class IdentityDecorator implements IdentityInterface
     /**
      * Identity data
      *
-     * @var \ArrayAccess|array
+     * @var \ArrayAccess<string, mixed>|array<string, mixed>
      */
     protected ArrayAccess|array $identity;
 
@@ -48,7 +48,7 @@ class IdentityDecorator implements IdentityInterface
      * Constructor
      *
      * @param \Authorization\AuthorizationServiceInterface $service The authorization service.
-     * @param \ArrayAccess|array $identity Identity data
+     * @param \ArrayAccess<string, mixed>|array<string, mixed> $identity Identity data
      */
     public function __construct(AuthorizationServiceInterface $service, ArrayAccess|array $identity)
     {
@@ -86,8 +86,7 @@ public function applyScope(string $action, mixed $resource, mixed ...$optionalAr
     public function getOriginalData(): ArrayAccess|array
     {
         if (
-            $this->identity
-            && !is_array($this->identity)
+            is_object($this->identity)
             && method_exists($this->identity, 'getOriginalData')
         ) {
             return $this->identity->getOriginalData();
@@ -100,18 +99,25 @@ public function getOriginalData(): ArrayAccess|array
      * Delegate unknown methods to decorated identity.
      *
      * @param string $method The method being invoked.
-     * @param array $args The arguments for the method.
+     * @param array<mixed> $args The arguments for the method.
      * @return mixed
      */
     public function __call(string $method, array $args): mixed
     {
         if (!is_object($this->identity)) {
             throw new BadMethodCallException("Cannot call `{$method}`. Identity data is not an object.");
         }
-        $call = [$this->identity, $method];
+
+        if (!method_exists($this->identity, $method)) {
+            throw new BadMethodCallException(sprintf(
+                'Method `%s` does not exist on `%s`.',
+                $method,
+                $this->identity::class,
+            ));
+        }
 
         /** @phpstan-ignore callable.nonCallable */
-        return $call(...$args);
+        return [$this->identity, $method](...$args);
     }
 
     /**

src/IdentityDecorator.php

@@ -26,7 +26,7 @@
  * and uses ArrayAccess to expose public properties of the wrapped identity
  * implementation.
  *
- * @extends \ArrayAccess<array-key, mixed>
+ * @extends \ArrayAccess<string, mixed>
  */
 interface IdentityInterface extends ArrayAccess
 {
@@ -64,7 +64,7 @@ public function applyScope(string $action, mixed $resource, mixed ...$optionalAr
      * If the decorated identity implements `getOriginalData()`
      * that method should be invoked to expose the original data.
      *
-     * @return \ArrayAccess|array
+     * @return \ArrayAccess<string, mixed>|array<string, mixed>
      */
     public function getOriginalData(): ArrayAccess|array;
 }

src/IdentityInterface.php

@@ -58,7 +58,7 @@ class AuthorizationMiddleware implements MiddlewareInterface
      *   check authorization. It is intended as a development aid and not to be relied upon
      *   in production. Defaults to `true`.
      *
-     * @var array
+     * @var array<string, mixed>
      */
     protected array $_defaultConfig = [
         'identityDecorator' => null,
@@ -179,7 +179,7 @@ protected function getAuthorizationService(
      * Builds the identity object.
      *
      * @param \Authorization\AuthorizationServiceInterface $service Authorization service.
-     * @param \ArrayAccess|array $identity Identity data
+     * @param \ArrayAccess<string, mixed>|array<string, mixed> $identity Identity data
      * @return \Authorization\IdentityInterface
      */
     protected function buildIdentity(