Add phpstan

Author: nojimage

.github/workflows/ci.yml

@@ -150,6 +150,6 @@ jobs:
 #        if: success() || failure()
 #        run: vendor/bin/psalm.phar --output-format=github
 #
-#      - name: Run phpstan
-#        if: success() || failure()
-#        run: vendor/bin/phpstan.phar analyse --error-format=github
+      - name: Run phpstan
+        if: success() || failure()
+        run: vendor/bin/phpstan.phar analyse --error-format=github

composer.json

@@ -21,6 +21,7 @@
     "cakephp/cakephp": "^5.0",
     "cakephp/cakephp-codesniffer": "^5.1",
     "cakephp/migrations": "^4.0",
+    "phpstan/phpstan": "^1.12",
     "phpunit/phpunit": "^10.5.5 || ^11.1.3 || ^12.0.9"
   },
   "autoload": {
@@ -36,8 +37,15 @@
     }
   },
   "scripts": {
+    "check": [
+      "@cs-check",
+      "@stan",
+      "@test"
+    ],
     "cs-check": "phpcs -p --extensions=php ./src ./tests",
     "cs-fix": "phpcbf -p --extensions=php ./src ./tests",
+    "stan": "phpstan analyse",
+    "test": "phpunit --colors=always",
     "update-lowest": "composer update --prefer-lowest --prefer-stable"
   },
   "config": {

phpstan.neon.dist

@@ -0,0 +1,11 @@
+parameters:
+    level: 8
+    checkMissingIterableValueType: false
+    treatPhpDocTypesAsCertain: false
+    paths:
+        - src/
+    excludePaths:
+        - test_app/
+    ignoreErrors:
+        -
+            identifier: missingType.generics

src/Authenticator/CookieAuthenticator.php

@@ -173,8 +173,13 @@ protected function _saveToken(ArrayAccess|array $identity, string $token): Entit
             throw new InvalidArgumentException('Can\'t detect user model');
         }
 
-        $userTable = $this->fetchTable($userModel);
-        /** @var \RememberMe\Model\Table\RememberMeTokensTableInterface $tokenTable */
+        $usersTable = $this->fetchTable($userModel);
+        $primaryKey = $usersTable->getPrimaryKey();
+        if (!is_string($primaryKey)) {
+            throw new InvalidArgumentException('User model must have a single primary key.');
+        }
+
+        /** @var \RememberMe\Model\Table\RememberMeTokensTableInterface&\Cake\ORM\Table $tokenTable */
         $tokenTable = $this->fetchTable($this->getConfig('tokenStorageModel'));
 
         if ($this->getConfig('dropExpiredToken')) {
@@ -185,7 +190,7 @@ protected function _saveToken(ArrayAccess|array $identity, string $token): Entit
         // create token entity
         $entity = $tokenTable->newEntity([
             'model' => $userModel,
-            'foreign_id' => $identity[$userTable->getPrimaryKey()],
+            'foreign_id' => $identity[$primaryKey],
             'series' => static::_generateToken($identity),
             'token' => $token,
             'expires' => new DateTime($this->getConfig('cookie.expire')),

src/Identifier/RememberMeTokenIdentifier.php

@@ -50,7 +50,7 @@ class RememberMeTokenIdentifier extends AbstractIdentifier
     /**
      * @inheritDoc
      */
-    protected function buildResolver($config): OrmResolver
+    protected function buildResolver(array|string $config): OrmResolver
     {
         $instance = $this->traitBuildResolver($config);
 
@@ -118,10 +118,10 @@ protected function _findIdentity(string $identifier): ArrayAccess|array|EntityIn
     }
 
     /**
-     * find user's remember me token.
+     * find some user's remember me token.
      *
      * @param \Cake\Datasource\EntityInterface $identity the identity
-     * @param string $series the credentials series
+     * @param string $series the credential series
      * @return \Cake\Datasource\EntityInterface|null
      */
     protected function _findToken(EntityInterface $identity, string $series): ?EntityInterface
@@ -133,11 +133,15 @@ protected function _findToken(EntityInterface $identity, string $series): ?Entit
 
         $usersTable = $this->getResolver()->fetchTable($userModel);
         $tokenStorageTable = $this->getResolver()->fetchTable($this->getConfig('tokenStorageModel'));
+        $primaryKey = $usersTable->getPrimaryKey();
+        if (!is_string($primaryKey)) {
+            throw new InvalidArgumentException('User model must have a single primary key.');
+        }
 
         return $tokenStorageTable->find()
             ->where([
                 'model' => $userModel,
-                'foreign_id' => $identity->get($usersTable->getPrimaryKey()),
+                'foreign_id' => $identity->get($primaryKey),
                 'series' => $series,
             ])
             ->first();

src/Model/Entity/RememberMeToken.php

@@ -20,23 +20,15 @@
 class RememberMeToken extends Entity
 {
     /**
-     * Fields that can be mass assigned using newEntity() or patchEntity().
-     *
-     * Note that when '*' is set to true, this allows all unspecified fields to
-     * be mass assigned. For security purposes, it is advised to set '*' to false
-     * (or remove it), and explicitly make individual fields accessible as needed.
-     *
-     * @var array
+     * @inheritDoc
      */
     protected array $_accessible = [
         '*' => true,
         'id' => false,
     ];
 
     /**
-     * Fields that are excluded from JSON versions of the entity.
-     *
-     * @var array
+     * @inheritDoc
      */
     protected array $_hidden = [
         'token',