Merge pull request #518 from kenjis/docs-remove-psalm-issues

docs: add annotation for psalm

Author: kenjis

src/Auth.php

@@ -129,6 +129,7 @@ public function getProvider(): UserModel
             return $this->userProvider;
         }
 
+        /** @var \CodeIgniter\Shield\Config\Auth $config */
         $config = config('Auth');
 
         if (! property_exists($config, 'userProvider')) {

src/Entities/User.php

@@ -14,10 +14,12 @@
 
 /**
  * @property string|null         $email
+ * @property int|string|null     $id
  * @property UserIdentity[]|null $identities
  * @property Time|null           $last_active
  * @property string|null         $password
  * @property string|null         $password_hash
+ * @property string|null         $username
  */
 class User extends Entity
 {

src/Models/UserModel.php

@@ -14,6 +14,9 @@
 use CodeIgniter\Shield\Exceptions\ValidationException;
 use Faker\Generator;
 
+/**
+ * @phpstan-consistent-constructor
+ */
 class UserModel extends Model
 {
     use CheckQueryReturnTrait;

tests/_support/Config/Registrar.php

@@ -24,6 +24,8 @@ class Registrar
      * DB config array for testing purposes.
      *
      * @var array
+     *
+     * @psalm-suppress RedundantCondition
      */
     protected static $dbConfig = [
         'MySQLi' => [