Merge pull request #540 from kenjis/fix-Config-Auth-class-string

refactor: use `::class` constants

Author: kenjis

docs/auth_actions.md

@@ -17,7 +17,7 @@ Shield ships with two actions you can use, and makes it simple for you to define
 Actions are setup in the `Auth` config file, with the `$actions` variable.
 
 ```php
-public $actions = [
+public array $actions = [
     'register' => null,
     'login'    => null,
 ];
@@ -26,9 +26,9 @@ public $actions = [
 To define an action to happen you will specify the class name as the value for the appropriate task:
 
 ```php
-public $actions = [
-    'register' => 'CodeIgniter\Shield\Authentication\Actions\EmailActivator',
-    'login'    => 'CodeIgniter\Shield\Authentication\Actions\Email2FA',
+public array $actions = [
+    'register' => \CodeIgniter\Shield\Authentication\Actions\EmailActivator::class,
+    'login'    => \CodeIgniter\Shield\Authentication\Actions\Email2FA::class,
 ];
 ```
 

docs/concepts.md

@@ -29,7 +29,7 @@ is provided for you at `CodeIgniter\Shield\Models\UserModel`. You can change thi
 The only requirement is that your new class MUST extend the provided `UserModel`.
 
 ```php
-public $userProvider = 'CodeIgniter\Shield\Models\UserModel';
+public string $userProvider = UserModel::class;
 ```
 
 ## User Identities
@@ -80,10 +80,10 @@ You can choose which validators are used in `Config\Auth::$passwordValidators`:
 
 ```php
 public $passwordValidators = [
-    'CodeIgniter\Shield\Authentication\Passwords\CompositionValidator',
-    'CodeIgniter\Shield\Authentication\Passwords\NothingPersonalValidator',
-    'CodeIgniter\Shield\Authentication\Passwords\DictionaryValidator',
-    //'CodeIgniter\Shield\Authentication\Passwords\PwnedValidator',
+    CompositionValidator::class,
+    NothingPersonalValidator::class,
+    DictionaryValidator::class,
+    // PwnedValidator::class,
 ];
 ```
 

docs/quickstart.md

@@ -113,7 +113,7 @@ By default, once a user registers they have an active account that can be used.
 
 ```php
 public array $actions = [
-    'register' => 'CodeIgniter\Shield\Authentication\Actions\EmailActivator',
+    'register' => \CodeIgniter\Shield\Authentication\Actions\EmailActivator::class,
     'login'    => null,
 ];
 ```
@@ -125,7 +125,7 @@ Turned off by default, Shield's Email-based 2FA can be enabled by specifying the
 ```php
 public array $actions = [
     'register' => null,
-    'login'    => 'CodeIgniter\Shield\Authentication\Actions\Email2FA',
+    'login'    => \CodeIgniter\Shield\Authentication\Actions\Email2FA::class,
 ];
 ```
 

src/Config/Auth.php

@@ -9,6 +9,10 @@
 use CodeIgniter\Shield\Authentication\AuthenticatorInterface;
 use CodeIgniter\Shield\Authentication\Authenticators\AccessTokens;
 use CodeIgniter\Shield\Authentication\Authenticators\Session;
+use CodeIgniter\Shield\Authentication\Passwords\CompositionValidator;
+use CodeIgniter\Shield\Authentication\Passwords\DictionaryValidator;
+use CodeIgniter\Shield\Authentication\Passwords\NothingPersonalValidator;
+use CodeIgniter\Shield\Authentication\Passwords\PwnedValidator;
 use CodeIgniter\Shield\Authentication\Passwords\ValidatorInterface;
 use CodeIgniter\Shield\Models\UserModel;
 
@@ -57,8 +61,8 @@ class Auth extends BaseConfig
      * You must register actions in the order of the actions to be performed.
      *
      * Available actions with Shield:
-     * - register: 'CodeIgniter\Shield\Authentication\Actions\EmailActivator'
-     * - login:    'CodeIgniter\Shield\Authentication\Actions\Email2FA'
+     * - register: \CodeIgniter\Shield\Authentication\Actions\EmailActivator::class
+     * - login:    \CodeIgniter\Shield\Authentication\Actions\Email2FA::class
      *
      * @var array<string, class-string<ActionInterface>|null>
      */
@@ -209,10 +213,10 @@ class Auth extends BaseConfig
      * @var class-string<ValidatorInterface>[]
      */
     public array $passwordValidators = [
-        'CodeIgniter\Shield\Authentication\Passwords\CompositionValidator',
-        'CodeIgniter\Shield\Authentication\Passwords\NothingPersonalValidator',
-        'CodeIgniter\Shield\Authentication\Passwords\DictionaryValidator',
-        // 'CodeIgniter\Shield\Authentication\Passwords\PwnedValidator',
+        CompositionValidator::class,
+        NothingPersonalValidator::class,
+        DictionaryValidator::class,
+        // PwnedValidator::class,
     ];
 
     /**
@@ -333,7 +337,7 @@ class Auth extends BaseConfig
      *
      * @var class-string<UserModel>
      */
-    public string $userProvider = 'CodeIgniter\Shield\Models\UserModel';
+    public string $userProvider = UserModel::class;
 
     /**
      * Returns the URL that a user should be redirected