Skip to content

Commit 059f63c

Browse files
kenjiskenjis
authored
Merge pull request #762 from codeigniter4/revert-748-refactor-use-class-in-config
Revert "refactor: use ::class keyword in config()"
2 parents 7f4503b + e53c7c9 commit 059f63c

23 files changed

+47
-95
lines changed

‎src/Auth.php‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@
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;
1311
use CodeIgniter\Shield\Entities\User;
1412
use CodeIgniter\Shield\Models\UserModel;
1513

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

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

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

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

‎src/Authentication/Actions/Email2FA.php‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
88
use CodeIgniter\HTTP\RedirectResponse;
99
use CodeIgniter\I18n\Time;
1010
use CodeIgniter\Shield\Authentication\Authenticators\Session;
11-
use CodeIgniter\Shield\Config\Auth;
1211
use CodeIgniter\Shield\Entities\User;
1312
use CodeIgniter\Shield\Entities\UserIdentity;
1413
use CodeIgniter\Shield\Exceptions\RuntimeException;
@@ -121,7 +120,7 @@ public function verify(IncomingRequest $request)
121120
}
122121

123122
// Get our login redirect url
124-
return redirect()->to(config(Auth::class)->loginRedirect());
123+
return redirect()->to(config('Auth')->loginRedirect());
125124
}
126125

127126
/**

‎src/Authentication/Actions/EmailActivator.php‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@
1010
use CodeIgniter\HTTP\Response;
1111
use CodeIgniter\I18n\Time;
1212
use CodeIgniter\Shield\Authentication\Authenticators\Session;
13-
use CodeIgniter\Shield\Config\Auth;
1413
use CodeIgniter\Shield\Entities\User;
1514
use CodeIgniter\Shield\Entities\UserIdentity;
1615
use CodeIgniter\Shield\Exceptions\LogicException;
@@ -115,7 +114,7 @@ public function verify(IncomingRequest $request)
115114
$user->activate();
116115

117116
// Success!
118-
return redirect()->to(config(Auth::class)->registerRedirect())
117+
return redirect()->to(config('Auth')->registerRedirect())
119118
->with('message', lang('Auth.registerSuccess'));
120119
}
121120

‎src/Authentication/Authenticators/AccessTokens.php‎

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

@@ -130,7 +129,7 @@ public function check(array $credentials): Result
130129
// Hasn't been used in a long time
131130
if (
132131
$token->last_used_at
133-
&& $token->last_used_at->isBefore(Time::now()->subSeconds(config(Auth::class)->unusedTokenLifetime))
132+
&& $token->last_used_at->isBefore(Time::now()->subSeconds(config('Auth')->unusedTokenLifetime))
134133
) {
135134
return new Result([
136135
'success' => false,
@@ -169,7 +168,7 @@ public function loggedIn(): bool
169168
$request = service('request');
170169

171170
return $this->attempt([
172-
'token' => $request->getHeaderLine(config(Auth::class)->authenticatorHeader['tokens']),
171+
'token' => $request->getHeaderLine(config('Auth')->authenticatorHeader['tokens']),
173172
])->isOK();
174173
}
175174

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

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

232231
if (empty($header)) {
233232
return null;

‎src/Authentication/Authenticators/Session.php‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@
1313
use CodeIgniter\Shield\Authentication\AuthenticationException;
1414
use CodeIgniter\Shield\Authentication\AuthenticatorInterface;
1515
use CodeIgniter\Shield\Authentication\Passwords;
16-
use CodeIgniter\Shield\Config\Auth;
1716
use CodeIgniter\Shield\Entities\User;
1817
use CodeIgniter\Shield\Entities\UserIdentity;
1918
use CodeIgniter\Shield\Exceptions\InvalidArgumentException;
@@ -90,7 +89,8 @@ public function __construct(UserModel $provider)
9089
*/
9190
private function checkSecurityConfig(): void
9291
{
93-
$securityConfig = config(Security::class);
92+
/** @var Security $securityConfig */
93+
$securityConfig = config('Security');
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::class)->validFields can be used.
279-
$field = array_intersect(config(Auth::class)->validFields ?? [], array_keys($credentials));
278+
// but any column within config('Auth')->validFields can be used.
279+
$field = array_intersect(config('Auth')->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::class)->hashAlgorithm === PASSWORD_BCRYPT) {
148+
if (config('Auth')->hashAlgorithm === PASSWORD_BCRYPT) {
149149
return 'max_byte[72]';
150150
}
151151

‎src/Authentication/Passwords/ValidationRules.php‎

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

77
use CodeIgniter\HTTP\IncomingRequest;
88
use CodeIgniter\Shield\Authentication\Passwords;
9-
use CodeIgniter\Shield\Config\Auth;
109
use CodeIgniter\Shield\Entities\User;
1110

1211
/**
@@ -103,7 +102,7 @@ protected function buildUserFromData(array $data = []): User
103102
*/
104103
protected function prepareValidFields(): array
105104
{
106-
$config = config(Auth::class);
105+
$config = config('Auth');
107106
$fields = array_merge($config->validFields, $config->personalFields);
108107
$fields[] = 'password';
109108

‎src/Authorization/Traits/Authorizable.php‎

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

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

259258
$matrix = function_exists('setting')
260259
? setting('AuthGroups.matrix')
261-
: config(AuthGroups::class)->matrix;
260+
: config('AuthGroups')->matrix;
262261

263262
foreach ($this->groupCache as $group) {
264263
// Check exact match
@@ -394,7 +393,7 @@ private function getConfigGroups(): array
394393
{
395394
return function_exists('setting')
396395
? array_keys(setting('AuthGroups.groups'))
397-
: array_keys(config(AuthGroups::class)->groups);
396+
: array_keys(config('AuthGroups')->groups);
398397
}
399398

400399
/**
@@ -404,6 +403,6 @@ private function getConfigPermissions(): array
404403
{
405404
return function_exists('setting')
406405
? array_keys(setting('AuthGroups.permissions'))
407-
: array_keys(config(AuthGroups::class)->permissions);
406+
: array_keys(config('AuthGroups')->permissions);
408407
}
409408
}

‎src/Config/Services.php‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@
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;
1211
use Config\Services as BaseService;
1312

1413
class Services extends BaseService
@@ -22,7 +21,7 @@ public static function auth(bool $getShared = true): Auth
2221
return self::getSharedInstance('auth');
2322
}
2423

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

2726
return new Auth(new Authentication($config));
2827
}
@@ -36,7 +35,7 @@ public static function passwords(bool $getShared = true): Passwords
3635
return self::getSharedInstance('passwords');
3736
}
3837

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

4241
/**

‎src/Controllers/LoginController.php‎

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,6 @@
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;
1311
use CodeIgniter\Shield\Traits\Viewable;
1412

1513
class LoginController extends BaseController
@@ -26,7 +24,7 @@ class LoginController extends BaseController
2624
public function loginView()
2725
{
2826
if (auth()->loggedIn()) {
29-
return redirect()->to(config(Auth::class)->loginRedirect());
27+
return redirect()->to(config('Auth')->loginRedirect());
3028
}
3129

3230
/** @var Session $authenticator */
@@ -73,7 +71,7 @@ public function loginAction(): RedirectResponse
7371
return redirect()->route('auth-action-show')->withCookies();
7472
}
7573

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

7977
/**
@@ -87,11 +85,11 @@ protected function getValidationRules(): array
8785
return setting('Validation.login') ?? [
8886
// 'username' => [
8987
// 'label' => 'Auth.username',
90-
// 'rules' => config(AuthSession::class)->usernameValidationRules,
88+
// 'rules' => config('AuthSession')->usernameValidationRules,
9189
// ],
9290
'email' => [
9391
'label' => 'Auth.email',
94-
'rules' => config(AuthSession::class)->emailValidationRules,
92+
'rules' => config('AuthSession')->emailValidationRules,
9593
],
9694
'password' => [
9795
'label' => 'Auth.password',
@@ -110,7 +108,7 @@ public function logoutAction(): RedirectResponse
110108
{
111109
// Capture logout redirect URL before auth logout,
112110
// otherwise you cannot check the user in `logoutRedirect()`.
113-
$url = config(Auth::class)->logoutRedirect();
111+
$url = config('Auth')->logoutRedirect();
114112

115113
auth()->logout();
116114

0 commit comments

Comments
 (0)