refactore: get rid of Authenticatable/UserProvider, use User/UserModel

Author: kenjis

src/Auth.php

@@ -7,8 +7,7 @@
 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\UserModel;
 
 /**
  * AuthenticatorInterface:
@@ -34,8 +33,8 @@ class Auth
      */
     protected ?string $alias = null;
 
-    protected ?Authenticatable $user      = null;
-    protected ?UserProvider $userProvider = null;
+    protected ?User $user              = null;
+    protected ?UserModel $userProvider = null;
 
     public function __construct(Authentication $authenticate)
     {
@@ -131,7 +130,7 @@ public function routes(RouteCollection &$routes, array $config = []): void
      *
      * @throws AuthenticationException
      */
-    public function getProvider(): UserProvider
+    public function getProvider(): UserModel
     {
         if ($this->userProvider !== null) {
             return $this->userProvider;

src/Authentication/Authentication.php

@@ -3,7 +3,7 @@
 namespace CodeIgniter\Shield\Authentication;
 
 use CodeIgniter\Shield\Config\Auth as AuthConfig;
-use CodeIgniter\Shield\Interfaces\UserProvider;
+use CodeIgniter\Shield\Models\UserModel;
 
 class Authentication
 {
@@ -15,7 +15,7 @@ class Authentication
      */
     protected array $instances = [];
 
-    protected ?UserProvider $userProvider = null;
+    protected ?UserModel $userProvider = null;
     protected AuthConfig $config;
 
     public function __construct(AuthConfig $config)
@@ -63,7 +63,7 @@ public function factory(?string $alias = null): AuthenticatorInterface
      *
      * @return $this
      */
-    public function setProvider(UserProvider $provider): self
+    public function setProvider(UserModel $provider): self
     {
         $this->userProvider = $provider;
 

src/Authentication/Authenticators/AccessTokens.php

@@ -7,9 +7,9 @@
 use CodeIgniter\Shield\Authentication\AuthenticationException;
 use CodeIgniter\Shield\Authentication\AuthenticatorInterface;
 use CodeIgniter\Shield\Entities\User;
-use CodeIgniter\Shield\Interfaces\UserProvider;
 use CodeIgniter\Shield\Models\LoginModel;
 use CodeIgniter\Shield\Models\UserIdentityModel;
+use CodeIgniter\Shield\Models\UserModel;
 use CodeIgniter\Shield\Result;
 use InvalidArgumentException;
 
@@ -18,20 +18,12 @@ class AccessTokens implements AuthenticatorInterface
     /**
      * The persistence engine
      */
-    protected UserProvider $provider;
+    protected UserModel $provider;
 
-    /**
-     * AccessTokens requires HasAccessTokens trait but there is no interface
-     * for this so the workaround is restricting this class to work with
-     * the native User instead of Authenticatable
-     *
-     * @todo Fix interface issue described above
-     */
     protected ?User $user = null;
-
     protected LoginModel $loginModel;
 
-    public function __construct(UserProvider $provider)
+    public function __construct(UserModel $provider)
     {
         helper('session');
         $this->provider   = $provider;

src/Authentication/Authenticators/Session.php

@@ -10,10 +10,9 @@
 use CodeIgniter\Shield\Authentication\AuthenticatorInterface;
 use CodeIgniter\Shield\Authentication\Passwords;
 use CodeIgniter\Shield\Entities\User;
-use CodeIgniter\Shield\Interfaces\Authenticatable;
-use CodeIgniter\Shield\Interfaces\UserProvider;
 use CodeIgniter\Shield\Models\LoginModel;
 use CodeIgniter\Shield\Models\RememberModel;
+use CodeIgniter\Shield\Models\UserModel;
 use CodeIgniter\Shield\Result;
 use Exception;
 use InvalidArgumentException;
@@ -23,7 +22,7 @@ class Session implements AuthenticatorInterface
     /**
      * The persistence engine
      */
-    protected UserProvider $provider;
+    protected UserModel $provider;
 
     protected ?User $user = null;
     protected LoginModel $loginModel;
@@ -35,7 +34,7 @@ class Session implements AuthenticatorInterface
 
     protected RememberModel $rememberModel;
 
-    public function __construct(UserProvider $provider)
+    public function __construct(UserModel $provider)
     {
         helper('setting');
         $this->provider      = $provider;
@@ -151,7 +150,7 @@ public function check(array $credentials): Result
      */
     public function loggedIn(): bool
     {
-        if ($this->user instanceof Authenticatable) {
+        if ($this->user instanceof User) {
             return true;
         }
 
@@ -161,7 +160,7 @@ public function loggedIn(): bool
         if ($userId !== null) {
             $this->user = $this->provider->findById($userId);
 
-            return $this->user instanceof Authenticatable;
+            return $this->user instanceof User;
         }
 
         return false;

src/Authentication/Traits/Authenticatable.php

@@ -3,7 +3,7 @@
 namespace CodeIgniter\Shield\Authentication\Traits;
 
 /**
- * Intended to be used with Authenticatable (User).
+ * Intended to be used with User.
  */
 trait Authenticatable
 {

src/Config/Auth.php

@@ -333,9 +333,9 @@ class Auth extends BaseConfig
      * By default, this is the included UserModel, which
      * works with any of the database engines supported by CodeIgniter.
      * You can change it as long as they adhere to the
-     * CodeIgniter\Shield\Interfaces\UserProvider.
+     * CodeIgniter\Shield\Models\UserModel.
      *
-     * @var class-string<\CodeIgniter\Shield\Interfaces\UserProvider>
+     * @var class-string<\CodeIgniter\Shield\Models\UserModel>
      */
     public string $userProvider = 'CodeIgniter\Shield\Models\UserModel';
 

src/Controllers/MagicLinkController.php

@@ -6,8 +6,8 @@
 use CodeIgniter\HTTP\RedirectResponse;
 use CodeIgniter\I18n\Time;
 use CodeIgniter\Shield\Auth;
-use CodeIgniter\Shield\Interfaces\UserProvider;
 use CodeIgniter\Shield\Models\UserIdentityModel;
+use CodeIgniter\Shield\Models\UserModel;
 
 /**
  * Handles "Magic Link" logins - an email-based
@@ -20,7 +20,7 @@
 class MagicLinkController extends BaseController
 {
     /**
-     * @var UserProvider
+     * @var UserModel
      */
     protected $provider;
 

src/Entities/User.php

@@ -10,7 +10,7 @@
 use CodeIgniter\Shield\Models\LoginModel;
 use CodeIgniter\Shield\Models\UserIdentityModel;
 
-class User extends Entity implements \CodeIgniter\Shield\Interfaces\Authenticatable
+class User extends Entity
 {
     use Authenticatable;
     use Authorizable;

src/Models/UserModel.php

@@ -5,11 +5,10 @@
 use CodeIgniter\Model;
 use CodeIgniter\Shield\Authentication\Traits\UserProvider as UserProviderTrait;
 use CodeIgniter\Shield\Entities\User;
-use CodeIgniter\Shield\Interfaces\UserProvider;
 use Faker\Generator;
 use InvalidArgumentException;
 
-class UserModel extends Model implements UserProvider
+class UserModel extends Model
 {
     use UserProviderTrait;