Merge pull request #377 from kenjis/fix-return-types

refactor: add return types

Author: kenjis

.php-cs-fixer.dist.php

@@ -17,6 +17,7 @@
 
 $overrides = [
     'declare_strict_types' => true,
+    'void_return'          => true,
 ];
 
 $options = [

src/Authentication/Actions/EmailActivator.php

@@ -7,6 +7,7 @@
 use CodeIgniter\Exceptions\PageNotFoundException;
 use CodeIgniter\HTTP\IncomingRequest;
 use CodeIgniter\HTTP\RedirectResponse;
+use CodeIgniter\HTTP\Response;
 use CodeIgniter\Shield\Authentication\Authenticators\Session;
 use CodeIgniter\Shield\Entities\User;
 use CodeIgniter\Shield\Exceptions\LogicException;
@@ -60,6 +61,8 @@ public function show(): string
 
     /**
      * This method is unused.
+     *
+     * @return Response|string
      */
     public function handle(IncomingRequest $request)
     {

src/Authentication/Authenticators/Session.php

@@ -408,7 +408,7 @@ private function checkUserState(): void
     /**
      * Gets identities for action from database, and set session.
      */
-    private function setAuthAction()
+    private function setAuthAction(): void
     {
         // Get identities for action
         $identities = $this->getIdentitiesForAction();
@@ -711,7 +711,7 @@ private function issueRememberMeToken(): void
         }
     }
 
-    private function removeRememberCookie()
+    private function removeRememberCookie(): void
     {
         /** @var Response $response */
         $response = service('response');

src/Commands/Setup.php

@@ -247,7 +247,7 @@ private function setupHelper(): void
         $this->add($file, $check, $pattern, $replace);
     }
 
-    private function setupRoutes()
+    private function setupRoutes(): void
     {
         $file = 'Config/Routes.php';
 

src/Filters/AuthRates.php

@@ -48,10 +48,8 @@ public function before(RequestInterface $request, $arguments = null)
      *
      * @param Response|ResponseInterface $response
      * @param array|null                 $arguments
-     *
-     * @return void
      */
-    public function after(RequestInterface $request, ResponseInterface $response, $arguments = null)
+    public function after(RequestInterface $request, ResponseInterface $response, $arguments = null): void
     {
         // Nothing required
     }

src/Filters/ChainAuth.php

@@ -56,10 +56,8 @@ public function before(RequestInterface $request, $arguments = null)
      *
      * @param Response|ResponseInterface $response
      * @param array|null                 $arguments
-     *
-     * @return void
      */
-    public function after(RequestInterface $request, ResponseInterface $response, $arguments = null)
+    public function after(RequestInterface $request, ResponseInterface $response, $arguments = null): void
     {
         // Nothing required
     }

src/Filters/SessionAuth.php

@@ -60,10 +60,8 @@ public function before(RequestInterface $request, $arguments = null)
      *
      * @param Response|ResponseInterface $response
      * @param array|null                 $arguments
-     *
-     * @return void
      */
-    public function after(RequestInterface $request, ResponseInterface $response, $arguments = null)
+    public function after(RequestInterface $request, ResponseInterface $response, $arguments = null): void
     {
     }
 }

src/Filters/TokenAuth.php

@@ -57,10 +57,8 @@ public function before(RequestInterface $request, $arguments = null)
      *
      * @param Response|ResponseInterface $response
      * @param array|null                 $arguments
-     *
-     * @return void
      */
-    public function after(RequestInterface $request, ResponseInterface $response, $arguments = null)
+    public function after(RequestInterface $request, ResponseInterface $response, $arguments = null): void
     {
     }
 }

src/Models/UserIdentityModel.php

@@ -203,6 +203,8 @@ public function getIdentityBySecret(string $type, ?string $secret): ?UserIdentit
     }
 
     /**
+     * Returns all identities.
+     *
      * @return UserIdentity[]
      */
     public function getIdentities(User $user): array
@@ -220,6 +222,9 @@ public function getIdentitiesByUserIds(array $userIds): array
         return $this->whereIn('user_id', $userIds)->orderBy($this->primaryKey)->findAll();
     }
 
+    /**
+     * Returns the first identity of the type.
+     */
     public function getIdentityByType(User $user, string $type): ?UserIdentity
     {
         return $this->where('user_id', $user->id)
@@ -229,6 +234,8 @@ public function getIdentityByType(User $user, string $type): ?UserIdentity
     }
 
     /**
+     * Returns all identities for the specific types.
+     *
      * @param string[] $types
      *
      * @return UserIdentity[]

src/Models/UserModel.php

@@ -222,7 +222,7 @@ public function activate(User $user): void
      *
      * @throws ValidationException
      *
-     * @retrun true|int|string Insert ID if $returnID is true
+     * @return int|string|true Insert ID if $returnID is true
      */
     public function insert($data = null, bool $returnID = true)
     {