refactor: add types for service()

Author: kenjis

src/Auth.php

@@ -9,6 +9,18 @@
 use CodeIgniter\Shield\Interfaces\Authenticatable;
 use CodeIgniter\Shield\Interfaces\UserProvider;
 
+/**
+ * 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()
+ */
 class Auth
 {
     protected Authentication $authenticate;

src/Authentication/Authenticators/AccessTokens.php

@@ -2,6 +2,7 @@
 
 namespace CodeIgniter\Shield\Authentication\Authenticators;
 
+use CodeIgniter\HTTP\IncomingRequest;
 use CodeIgniter\I18n\Time;
 use CodeIgniter\Shield\Authentication\AuthenticationException;
 use CodeIgniter\Shield\Authentication\AuthenticatorInterface;
@@ -46,7 +47,9 @@ public function __construct($provider)
      */
     public function attempt(array $credentials): Result
     {
-        $request   = service('request');
+        /** @var IncomingRequest $request */
+        $request = service('request');
+
         $ipAddress = $request->getIPAddress();
         $userAgent = $request->getUserAgent();
 
@@ -138,8 +141,11 @@ public function loggedIn(): bool
             return true;
         }
 
+        /** @var IncomingRequest $request */
+        $request = service('request');
+
         return $this->attempt([
-            'token' => service('request')->getHeaderLine(config('Auth')->authenticatorHeader['tokens']),
+            'token' => $request->getHeaderLine(config('Auth')->authenticatorHeader['tokens']),
         ])->isOK();
     }
 
@@ -216,6 +222,7 @@ public function getUser()
      */
     public function getBearerToken()
     {
+        /** @var IncomingRequest $request */
         $request = service('request');
 
         $header = $request->getHeaderLine(config('Auth')->authenticatorHeader['tokens']);

src/Authentication/Authenticators/Session.php

@@ -3,6 +3,8 @@
 namespace CodeIgniter\Shield\Authentication\Authenticators;
 
 use CodeIgniter\Events\Events;
+use CodeIgniter\HTTP\IncomingRequest;
+use CodeIgniter\HTTP\Response;
 use CodeIgniter\I18n\Time;
 use CodeIgniter\Shield\Authentication\AuthenticationException;
 use CodeIgniter\Shield\Authentication\AuthenticatorInterface;
@@ -60,7 +62,9 @@ public function remember(bool $shouldRemember = true)
      */
     public function attempt(array $credentials)
     {
-        $request   = service('request');
+        /** @var IncomingRequest $request */
+        $request = service('request');
+
         $ipAddress = $request->getIPAddress();
         $userAgent = $request->getUserAgent();
         $result    = $this->check($credentials);
@@ -116,10 +120,10 @@ public function check(array $credentials)
             ]);
         }
 
-        // Now, try matching the passwords.
         /** @var Passwords $passwords */
         $passwords = service('passwords');
 
+        // Now, try matching the passwords.
         if (! $passwords->verify($givenPassword, $user->password_hash)) {
             return new Result([
                 'success' => false,
@@ -190,8 +194,11 @@ public function login(Authenticatable $user)
         // Let the session know we're logged in
         session()->set(setting('Auth.sessionConfig')['field'], $this->user->getAuthId());
 
+        /** @var Response $response */
+        $response = service('response');
+
         // When logged in, ensure cache control headers are in place
-        service('response')->noCache();
+        $response->noCache();
 
         if ($this->shouldRemember && setting('Auth.sessionConfig')['allowRemembering']) {
             $this->rememberUser($this->user->getAuthId());
@@ -330,9 +337,10 @@ protected function rememberUser($userId): void
         // Store it in the database
         $this->rememberModel->rememberUser($userId, $selector, hash('sha256', $validator), $expires);
 
-        // Save it to the user's browser in a cookie.
+        /** @var Response $response */
         $response = service('response');
 
+        // Save it to the user's browser in a cookie.
         // Create the cookie
         $response->setCookie(
             setting('Auth.sessionConfig')['rememberCookieName'],

src/Authentication/Passwords/ValidationRules.php

@@ -2,6 +2,7 @@
 
 namespace CodeIgniter\Shield\Authentication\Passwords;
 
+use CodeIgniter\HTTP\IncomingRequest;
 use CodeIgniter\Shield\Entities\User;
 
 /**
@@ -61,7 +62,10 @@ protected function buildUserFromRequest()
     {
         $fields = $this->prepareValidFields();
 
-        $data = service('request')->getPost($fields);
+        /** @var IncomingRequest $request */
+        $request = service('request');
+
+        $data = $request->getPost($fields);
 
         return new User($data);
     }

src/Controllers/LoginController.php

@@ -4,6 +4,7 @@
 
 use App\Controllers\BaseController;
 use CodeIgniter\Events\Events;
+use CodeIgniter\HTTP\IncomingRequest;
 use CodeIgniter\HTTP\RedirectResponse;
 
 class LoginController extends BaseController
@@ -23,7 +24,9 @@ public function loginView(): string
      */
     public function loginAction(): RedirectResponse
     {
-        $request                 = service('request');
+        /** @var IncomingRequest $request */
+        $request = service('request');
+
         $credentials             = $request->getPost(setting('Auth.validFields'));
         $credentials             = array_filter($credentials);
         $credentials['password'] = $request->getPost('password');

src/Controllers/MagicLinkController.php

@@ -5,6 +5,7 @@
 use App\Controllers\BaseController;
 use CodeIgniter\HTTP\RedirectResponse;
 use CodeIgniter\I18n\Time;
+use CodeIgniter\Shield\Auth;
 use CodeIgniter\Shield\Interfaces\UserProvider;
 use CodeIgniter\Shield\Models\UserIdentityModel;
 
@@ -117,8 +118,10 @@ public function verify(): RedirectResponse
             return redirect()->route('magic-link')->with('error', lang('Auth.magicLinkExpired'));
         }
 
-        // Log the user in
+        /** @var Auth $auth */
         $auth = service('auth');
+
+        // Log the user in
         $auth->loginById($identity->user_id);
 
         // Get our login redirect url

src/Controllers/RegisterController.php

@@ -6,6 +6,7 @@
 use CodeIgniter\Events\Events;
 use CodeIgniter\HTTP\RedirectResponse;
 use CodeIgniter\Shield\Entities\User;
+use CodeIgniter\Validation\Validation;
 
 /**
  * Class RegisterController
@@ -50,9 +51,11 @@ public function registerAction(): RedirectResponse
         // like the password, can only be validated properly here.
         $rules = $this->getValidationRules();
 
+        /** @var Validation $validation */
+        $validation = service('validation');
+
         if (! $this->validate($rules)) {
-            return redirect()->back()->withInput()
-                ->with('errors', service('validation')->getErrors());
+            return redirect()->back()->withInput()->with('errors', $validation->getErrors());
         }
 
         // Save the user

src/Entities/User.php

@@ -3,6 +3,7 @@
 namespace CodeIgniter\Shield\Entities;
 
 use CodeIgniter\Entity\Entity;
+use CodeIgniter\Shield\Authentication\Passwords;
 use CodeIgniter\Shield\Authentication\Traits\Authenticatable;
 use CodeIgniter\Shield\Authentication\Traits\HasAccessTokens;
 use CodeIgniter\Shield\Authorization\Traits\Authorizable;
@@ -96,11 +97,14 @@ public function createEmailIdentity(array $credentials)
         /** @var UserIdentityModel $identityModel */
         $identityModel = model(UserIdentityModel::class);
 
+        /** @var Passwords $passwords */
+        $passwords = service('passwords');
+
         $identityModel->insert([
             'user_id' => $this->id,
             'type'    => 'email_password',
             'secret'  => $credentials['email'],
-            'secret2' => service('passwords')->hash($credentials['password']),
+            'secret2' => $passwords->hash($credentials['password']),
         ]);
     }
 

src/Entities/UserIdentity.php

@@ -3,6 +3,7 @@
 namespace CodeIgniter\Shield\Entities;
 
 use CodeIgniter\Entity\Entity;
+use CodeIgniter\Shield\Authentication\Passwords;
 
 /**
  * Class UserIdentity
@@ -36,7 +37,10 @@ class UserIdentity extends Entity
      */
     public function hashSecret(string $value)
     {
-        $this->attributes['secret'] = service('passwords')->hash($value);
+        /** @var Passwords $passwords */
+        $passwords = service('passwords');
+
+        $this->attributes['secret'] = $passwords->hash($value);
 
         return $this;
     }

src/Helpers/auth_helper.php

@@ -27,6 +27,9 @@ function auth(?string $alias = null)
      */
     function user_id()
     {
-        return service('auth')->id();
+        /** @var Auth $auth */
+        $auth = service('auth');
+
+        return $auth->id();
     }
 }