Skip to content

Commit 736a88f

Browse files
kenjiskenjis
authored
Merge pull request #748 from kenjis/refactor-use-class-in-config
refactor: use ::class keyword in config()
2 parents 3dc2154 + bee838a commit 736a88f

23 files changed

+95
-47
lines changed

‎src/Auth.php

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
use CodeIgniter\Shield\Authentication\Authentication;
99
use CodeIgniter\Shield\Authentication\AuthenticationException;
1010
use CodeIgniter\Shield\Authentication\AuthenticatorInterface;
11+
use CodeIgniter\Shield\Config\Auth as AuthConfig;
12+
use CodeIgniter\Shield\Config\AuthRoutes;
1113
use CodeIgniter\Shield\Entities\User;
1214
use CodeIgniter\Shield\Models\UserModel;
1315

@@ -106,7 +108,7 @@ public function authenticate(array $credentials): Result
106108
*/
107109
public function routes(RouteCollection &$routes, array $config = []): void
108110
{
109-
$authRoutes = config('AuthRoutes')->routes;
111+
$authRoutes = config(AuthRoutes::class)->routes;
110112

111113
$routes->group('/', ['namespace' => 'CodeIgniter\Shield\Controllers'], static function (RouteCollection $routes) use ($authRoutes, $config): void {
112114
foreach ($authRoutes as $name => $row) {
@@ -133,8 +135,7 @@ public function getProvider(): UserModel
133135
return $this->userProvider;
134136
}
135137

136-
/** @var \CodeIgniter\Shield\Config\Auth $config */
137-
$config = config('Auth');
138+
$config = config(AuthConfig::class);
138139

139140
if (! property_exists($config, 'userProvider')) {
140141
throw AuthenticationException::forUnknownUserProvider();

‎src/Authentication/Actions/Email2FA.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
use CodeIgniter\HTTP\RedirectResponse;
99
use CodeIgniter\I18n\Time;
1010
use CodeIgniter\Shield\Authentication\Authenticators\Session;
11+
use CodeIgniter\Shield\Config\Auth;
1112
use CodeIgniter\Shield\Entities\User;
1213
use CodeIgniter\Shield\Entities\UserIdentity;
1314
use CodeIgniter\Shield\Exceptions\RuntimeException;
@@ -120,7 +121,7 @@ public function verify(IncomingRequest $request)
120121
}
121122

122123
// Get our login redirect url
123-
return redirect()->to(config('Auth')->loginRedirect());
124+
return redirect()->to(config(Auth::class)->loginRedirect());
124125
}
125126

126127
/**

‎src/Authentication/Actions/EmailActivator.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
use CodeIgniter\HTTP\Response;
1111
use CodeIgniter\I18n\Time;
1212
use CodeIgniter\Shield\Authentication\Authenticators\Session;
13+
use CodeIgniter\Shield\Config\Auth;
1314
use CodeIgniter\Shield\Entities\User;
1415
use CodeIgniter\Shield\Entities\UserIdentity;
1516
use CodeIgniter\Shield\Exceptions\LogicException;
@@ -114,7 +115,7 @@ public function verify(IncomingRequest $request)
114115
$user->activate();
115116

116117
// Success!
117-
return redirect()->to(config('Auth')->registerRedirect())
118+
return redirect()->to(config(Auth::class)->registerRedirect())
118119
->with('message', lang('Auth.registerSuccess'));
119120
}
120121

‎src/Authentication/Authenticators/AccessTokens.php

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
use CodeIgniter\I18n\Time;
99
use CodeIgniter\Shield\Authentication\AuthenticationException;
1010
use CodeIgniter\Shield\Authentication\AuthenticatorInterface;
11+
use CodeIgniter\Shield\Config\Auth;
1112
use CodeIgniter\Shield\Entities\User;
1213
use CodeIgniter\Shield\Exceptions\InvalidArgumentException;
1314
use CodeIgniter\Shield\Models\TokenLoginModel;
@@ -104,7 +105,7 @@ public function check(array $credentials): Result
104105
if (! array_key_exists('token', $credentials) || empty($credentials['token'])) {
105106
return new Result([
106107
'success' => false,
107-
'reason' => lang('Auth.noToken', [config('Auth')->authenticatorHeader['tokens']]),
108+
'reason' => lang('Auth.noToken', [config(Auth::class)->authenticatorHeader['tokens']]),
108109
]);
109110
}
110111

@@ -129,7 +130,7 @@ public function check(array $credentials): Result
129130
// Hasn't been used in a long time
130131
if (
131132
$token->last_used_at
132-
&& $token->last_used_at->isBefore(Time::now()->subSeconds(config('Auth')->unusedTokenLifetime))
133+
&& $token->last_used_at->isBefore(Time::now()->subSeconds(config(Auth::class)->unusedTokenLifetime))
133134
) {
134135
return new Result([
135136
'success' => false,
@@ -168,7 +169,7 @@ public function loggedIn(): bool
168169
$request = service('request');
169170

170171
return $this->attempt([
171-
'token' => $request->getHeaderLine(config('Auth')->authenticatorHeader['tokens']),
172+
'token' => $request->getHeaderLine(config(Auth::class)->authenticatorHeader['tokens']),
172173
])->isOK();
173174
}
174175

@@ -226,7 +227,7 @@ public function getBearerToken(): ?string
226227
/** @var IncomingRequest $request */
227228
$request = service('request');
228229

229-
$header = $request->getHeaderLine(config('Auth')->authenticatorHeader['tokens']);
230+
$header = $request->getHeaderLine(config(Auth::class)->authenticatorHeader['tokens']);
230231

231232
if (empty($header)) {
232233
return null;

‎src/Authentication/Authenticators/Session.php

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
use CodeIgniter\Shield\Authentication\AuthenticationException;
1414
use CodeIgniter\Shield\Authentication\AuthenticatorInterface;
1515
use CodeIgniter\Shield\Authentication\Passwords;
16+
use CodeIgniter\Shield\Config\Auth;
1617
use CodeIgniter\Shield\Entities\User;
1718
use CodeIgniter\Shield\Entities\UserIdentity;
1819
use CodeIgniter\Shield\Exceptions\InvalidArgumentException;
@@ -89,8 +90,7 @@ public function __construct(UserModel $provider)
8990
*/
9091
private function checkSecurityConfig(): void
9192
{
92-
/** @var Security $securityConfig */
93-
$securityConfig = config('Security');
93+
$securityConfig = config(Security::class);
9494

9595
if ($securityConfig->csrfProtection === 'cookie') {
9696
throw new SecurityException(
@@ -275,8 +275,8 @@ private function recordLoginAttempt(
275275
): void {
276276
// Determine the type of ID we're using.
277277
// Standard fields would be email, username,
278-
// but any column within config('Auth')->validFields can be used.
279-
$field = array_intersect(config('Auth')->validFields ?? [], array_keys($credentials));
278+
// but any column within config(Auth::class)->validFields can be used.
279+
$field = array_intersect(config(Auth::class)->validFields ?? [], array_keys($credentials));
280280

281281
if (count($field) !== 1) {
282282
throw new InvalidArgumentException('Invalid credentials passed to recordLoginAttempt.');

‎src/Authentication/Passwords.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -145,7 +145,7 @@ public function check(string $password, ?User $user = null): Result
145145
*/
146146
public static function getMaxLengthRule(): string
147147
{
148-
if (config('Auth')->hashAlgorithm === PASSWORD_BCRYPT) {
148+
if (config(Auth::class)->hashAlgorithm === PASSWORD_BCRYPT) {
149149
return 'max_byte[72]';
150150
}
151151

‎src/Authentication/Passwords/ValidationRules.php

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77
use CodeIgniter\HTTP\IncomingRequest;
88
use CodeIgniter\Shield\Authentication\Passwords;
9+
use CodeIgniter\Shield\Config\Auth;
910
use CodeIgniter\Shield\Entities\User;
1011

1112
/**
@@ -97,7 +98,7 @@ protected function buildUserFromData(array $data = []): User
9798
*/
9899
protected function prepareValidFields(): array
99100
{
100-
$config = config('Auth');
101+
$config = config(Auth::class);
101102
$fields = array_merge($config->validFields, $config->personalFields);
102103
$fields[] = 'password';
103104

‎src/Authorization/Traits/Authorizable.php

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77
use CodeIgniter\I18n\Time;
88
use CodeIgniter\Shield\Authorization\AuthorizationException;
9+
use CodeIgniter\Shield\Config\AuthGroups;
910
use CodeIgniter\Shield\Exceptions\LogicException;
1011
use CodeIgniter\Shield\Models\GroupModel;
1112
use CodeIgniter\Shield\Models\PermissionModel;
@@ -257,7 +258,7 @@ public function can(string $permission): bool
257258

258259
$matrix = function_exists('setting')
259260
? setting('AuthGroups.matrix')
260-
: config('AuthGroups')->matrix;
261+
: config(AuthGroups::class)->matrix;
261262

262263
foreach ($this->groupCache as $group) {
263264
// Check exact match
@@ -393,7 +394,7 @@ private function getConfigGroups(): array
393394
{
394395
return function_exists('setting')
395396
? array_keys(setting('AuthGroups.groups'))
396-
: array_keys(config('AuthGroups')->groups);
397+
: array_keys(config(AuthGroups::class)->groups);
397398
}
398399

399400
/**
@@ -403,6 +404,6 @@ private function getConfigPermissions(): array
403404
{
404405
return function_exists('setting')
405406
? array_keys(setting('AuthGroups.permissions'))
406-
: array_keys(config('AuthGroups')->permissions);
407+
: array_keys(config(AuthGroups::class)->permissions);
407408
}
408409
}

‎src/Config/Services.php

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@
88
use CodeIgniter\Shield\Authentication\Authentication;
99
use CodeIgniter\Shield\Authentication\JWTManager;
1010
use CodeIgniter\Shield\Authentication\Passwords;
11+
use CodeIgniter\Shield\Config\Auth as AuthConfig;
1112
use Config\Services as BaseService;
1213

1314
class Services extends BaseService
@@ -21,7 +22,7 @@ public static function auth(bool $getShared = true): Auth
2122
return self::getSharedInstance('auth');
2223
}
2324

24-
$config = config('Auth');
25+
$config = config(AuthConfig::class);
2526

2627
return new Auth(new Authentication($config));
2728
}
@@ -35,7 +36,7 @@ public static function passwords(bool $getShared = true): Passwords
3536
return self::getSharedInstance('passwords');
3637
}
3738

38-
return new Passwords(config('Auth'));
39+
return new Passwords(config(AuthConfig::class));
3940
}
4041

4142
/**

‎src/Controllers/LoginController.php

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@
88
use CodeIgniter\HTTP\RedirectResponse;
99
use CodeIgniter\Shield\Authentication\Authenticators\Session;
1010
use CodeIgniter\Shield\Authentication\Passwords;
11+
use CodeIgniter\Shield\Config\Auth;
12+
use CodeIgniter\Shield\Config\AuthSession;
1113
use CodeIgniter\Shield\Traits\Viewable;
1214

1315
class LoginController extends BaseController
@@ -24,7 +26,7 @@ class LoginController extends BaseController
2426
public function loginView()
2527
{
2628
if (auth()->loggedIn()) {
27-
return redirect()->to(config('Auth')->loginRedirect());
29+
return redirect()->to(config(Auth::class)->loginRedirect());
2830
}
2931

3032
/** @var Session $authenticator */
@@ -71,7 +73,7 @@ public function loginAction(): RedirectResponse
7173
return redirect()->route('auth-action-show')->withCookies();
7274
}
7375

74-
return redirect()->to(config('Auth')->loginRedirect())->withCookies();
76+
return redirect()->to(config(Auth::class)->loginRedirect())->withCookies();
7577
}
7678

7779
/**
@@ -85,11 +87,11 @@ protected function getValidationRules(): array
8587
return setting('Validation.login') ?? [
8688
// 'username' => [
8789
// 'label' => 'Auth.username',
88-
// 'rules' => config('AuthSession')->usernameValidationRules,
90+
// 'rules' => config(AuthSession::class)->usernameValidationRules,
8991
// ],
9092
'email' => [
9193
'label' => 'Auth.email',
92-
'rules' => config('AuthSession')->emailValidationRules,
94+
'rules' => config(AuthSession::class)->emailValidationRules,
9395
],
9496
'password' => [
9597
'label' => 'Auth.password',
@@ -108,7 +110,7 @@ public function logoutAction(): RedirectResponse
108110
{
109111
// Capture logout redirect URL before auth logout,
110112
// otherwise you cannot check the user in `logoutRedirect()`.
111-
$url = config('Auth')->logoutRedirect();
113+
$url = config(Auth::class)->logoutRedirect();
112114

113115
auth()->logout();
114116

0 commit comments

Comments
 (0)