refactor: replace Authenticatable with User

Author: kenjis

src/Auth.php

@@ -13,14 +13,14 @@
 /**
  * AuthenticatorInterface:
  *
- * @method Result               attempt(array $credentials)
- * @method Result               check(array $credentials)
- * @method Authenticatable|null getUser()
- * @method bool                 loggedIn()
- * @method bool                 login(Authenticatable $user)
- * @method void                 loginById($userId)
- * @method bool                 logout()
- * @method void                 recordActive()
+ * @method Result    attempt(array $credentials)
+ * @method Result    check(array $credentials)
+ * @method User|null getUser()
+ * @method bool      loggedIn()
+ * @method bool      login(User $user)
+ * @method void      loginById($userId)
+ * @method bool      logout()
+ * @method void      recordActive()
  *
  * Authenticators\Session:
  * @method $this remember(bool $shouldRemember = true)

src/Authentication/Authenticators/AccessTokens.php

@@ -7,7 +7,6 @@
 use CodeIgniter\Shield\Authentication\AuthenticationException;
 use CodeIgniter\Shield\Authentication\AuthenticatorInterface;
 use CodeIgniter\Shield\Entities\User;
-use CodeIgniter\Shield\Interfaces\Authenticatable;
 use CodeIgniter\Shield\Interfaces\UserProvider;
 use CodeIgniter\Shield\Models\LoginModel;
 use CodeIgniter\Shield\Models\UserIdentityModel;
@@ -227,7 +226,7 @@ public function getBearerToken(): ?string
      */
     public function recordActive(): void
     {
-        if (! $this->user instanceof Authenticatable) {
+        if (! $this->user instanceof User) {
             throw new InvalidArgumentException(self::class . '::recordActive() requires logged in user before calling.');
         }
 

src/Authentication/Authenticators/Session.php

@@ -290,7 +290,7 @@ public function getUser(): ?User
      */
     public function recordActive(): void
     {
-        if (! $this->user instanceof Authenticatable) {
+        if (! $this->user instanceof User) {
             throw new InvalidArgumentException(self::class . '::recordActive() requires logged in user before calling.');
         }
 

src/Authentication/Traits/UserProvider.php

@@ -3,7 +3,6 @@
 namespace CodeIgniter\Shield\Authentication\Traits;
 
 use CodeIgniter\Shield\Entities\User;
-use CodeIgniter\Shield\Interfaces\Authenticatable;
 
 /**
  * Intended to be used with UserProvider (UserModel).
@@ -70,7 +69,7 @@ public function findByCredentials(array $credentials): ?User
      *
      * @param int|string $id
      */
-    public function findByRememberToken($id, string $token): ?Authenticatable
+    public function findByRememberToken($id, string $token): ?User
     {
         return $this->where([
             'id'          => $id,

src/Interfaces/UserProvider.php

@@ -25,12 +25,12 @@ public function findByCredentials(array $credentials): ?User;
      *
      * @param int|string $id
      */
-    public function findByRememberToken($id, string $token): ?Authenticatable;
+    public function findByRememberToken($id, string $token): ?User;
 
     /**
      * Given a User object, will update the record
      * in the database. This is often a User entity
      * that already has the correct values set.
      */
-    public function save(Authenticatable $data): bool;
+    public function save(User $data): bool;
 }

src/Result.php

@@ -3,7 +3,6 @@
 namespace CodeIgniter\Shield;
 
 use CodeIgniter\Shield\Entities\User;
-use CodeIgniter\Shield\Interfaces\Authenticatable;
 
 class Result
 {
@@ -19,13 +18,13 @@ class Result
     /**
      * Extra information.
      *
-     * @var Authenticatable|string|null `Authenticatable` when successful. Suggestion strings when fails.
+     * @var string|User|null `User` when successful. Suggestion strings when fails.
      */
     protected $extraInfo;
 
     /**
-     * @phpstan-param array{success: bool, reason?: string|null, extraInfo?: string|Authenticatable} $details
-     * @psalm-param array{success: bool, reason?: string|null, extraInfo?: string|Authenticatable} $details
+     * @phpstan-param array{success: bool, reason?: string|null, extraInfo?: string|User} $details
+     * @psalm-param array{success: bool, reason?: string|null, extraInfo?: string|User} $details
      */
     public function __construct(array $details)
     {

src/Test/AuthenticationTesting.php

@@ -3,7 +3,6 @@
 namespace CodeIgniter\Shield\Test;
 
 use CodeIgniter\Shield\Entities\User;
-use CodeIgniter\Shield\Interfaces\Authenticatable;
 
 /**
  * Trait AuthenticationTesting
@@ -17,7 +16,7 @@ trait AuthenticationTesting
      *
      * @return $this
      */
-    public function actingAs(Authenticatable $user): self
+    public function actingAs(User $user): self
     {
         // Ensure the helper is loaded during tests.
         helper('auth');