Merge pull request #286 from kenjis/fix-exception-structure

fix: Exception structure
codeigniter4 · Jul 15, 2022 · dadd7b3 · dadd7b3
2 parents 794275f + d8342dd
commit dadd7b3
Show file tree

Hide file tree

Showing 12 changed files with 29 additions and 20 deletions.
diff --git a/src/Authentication/AuthenticationException.php b/src/Authentication/AuthenticationException.php
@@ -3,9 +3,9 @@
 namespace CodeIgniter\Shield\Authentication;
 
 use CodeIgniter\HTTP\Exceptions\HTTPException;
-use Exception;
+use CodeIgniter\Shield\Exceptions\RuntimeException;
 
-class AuthenticationException extends Exception
+class AuthenticationException extends RuntimeException
 {
     protected $code = 403;
 

diff --git a/src/Authentication/Authenticators/AccessTokens.php b/src/Authentication/Authenticators/AccessTokens.php
@@ -7,11 +7,11 @@
 use CodeIgniter\Shield\Authentication\AuthenticationException;
 use CodeIgniter\Shield\Authentication\AuthenticatorInterface;
 use CodeIgniter\Shield\Entities\User;
+use CodeIgniter\Shield\Exceptions\InvalidArgumentException;
 use CodeIgniter\Shield\Models\TokenLoginModel;
 use CodeIgniter\Shield\Models\UserIdentityModel;
 use CodeIgniter\Shield\Models\UserModel;
 use CodeIgniter\Shield\Result;
-use InvalidArgumentException;
 
 class AccessTokens implements AuthenticatorInterface
 {

diff --git a/src/Authentication/Authenticators/Session.php b/src/Authentication/Authenticators/Session.php
@@ -13,14 +13,13 @@
 use CodeIgniter\Shield\Authentication\Passwords;
 use CodeIgniter\Shield\Entities\User;
 use CodeIgniter\Shield\Entities\UserIdentity;
+use CodeIgniter\Shield\Exceptions\InvalidArgumentException;
 use CodeIgniter\Shield\Exceptions\LogicException;
 use CodeIgniter\Shield\Models\LoginModel;
 use CodeIgniter\Shield\Models\RememberModel;
 use CodeIgniter\Shield\Models\UserIdentityModel;
 use CodeIgniter\Shield\Models\UserModel;
 use CodeIgniter\Shield\Result;
-use Exception;
-use InvalidArgumentException;
 use stdClass;
 
 class Session implements AuthenticatorInterface
@@ -812,8 +811,6 @@ public function recordActiveDate(): void
      * and stores the necessary info in the db and a cookie.
      *
      * @see https://paragonie.com/blog/2015/04/secure-authentication-php-with-long-term-persistence
-     *
-     * @throws Exception
      */
     protected function rememberUser(User $user): void
     {

diff --git a/src/Authorization/AuthorizationException.php b/src/Authorization/AuthorizationException.php
@@ -2,9 +2,9 @@
 
 namespace CodeIgniter\Shield\Authorization;
 
-use Exception;
+use CodeIgniter\Shield\Exceptions\RuntimeException;
 
-class AuthorizationException extends Exception
+class AuthorizationException extends RuntimeException
 {
     protected $code = 401;
 

diff --git a/src/Authorization/Groups.php b/src/Authorization/Groups.php
@@ -3,7 +3,7 @@
 namespace CodeIgniter\Shield\Authorization;
 
 use CodeIgniter\Shield\Entities\Group;
-use RuntimeException;
+use CodeIgniter\Shield\Exceptions\RuntimeException;
 
 /**
  * Provides utility feature for working with

diff --git a/src/Exceptions/BaseException.php b/src/Exceptions/BaseException.php
@@ -0,0 +1,12 @@
+<?php
+
+namespace CodeIgniter\Shield\Exceptions;
+
+use Throwable;
+
+/**
+ * Base Exception Interface for Shield
+ */
+interface BaseException extends Throwable
+{
+}
diff --git a/src/Exceptions/InvalidArgumentException.php b/src/Exceptions/InvalidArgumentException.php
@@ -0,0 +1,7 @@
+<?php
+
+namespace CodeIgniter\Shield\Exceptions;
+
+class InvalidArgumentException extends LogicException implements BaseException
+{
+}
diff --git a/src/Exceptions/LogicException.php b/src/Exceptions/LogicException.php
@@ -2,6 +2,6 @@
 
 namespace CodeIgniter\Shield\Exceptions;
 
-class LogicException extends \LogicException
+class LogicException extends \LogicException implements BaseException
 {
 }
diff --git a/src/Exceptions/RuntimeException.php b/src/Exceptions/RuntimeException.php
@@ -2,6 +2,6 @@
 
 namespace CodeIgniter\Shield\Exceptions;
 
-class RuntimeException extends \RuntimeException
+class RuntimeException extends \RuntimeException implements BaseException
 {
 }
diff --git a/src/Models/LoginModel.php b/src/Models/LoginModel.php
@@ -7,7 +7,6 @@
 use CodeIgniter\Shield\Authentication\Authenticators\Session;
 use CodeIgniter\Shield\Entities\Login;
 use CodeIgniter\Shield\Entities\User;
-use Exception;
 use Faker\Generator;
 
 class LoginModel extends Model
@@ -81,8 +80,6 @@ public function lastLogin(User $user): ?Login
 
     /**
      * Generate a fake login for testing
-     *
-     * @throws Exception
      */
     public function fake(Generator &$faker): Login
     {

diff --git a/src/Models/TokenLoginModel.php b/src/Models/TokenLoginModel.php
@@ -4,7 +4,6 @@
 
 use CodeIgniter\I18n\Time;
 use CodeIgniter\Shield\Entities\Login;
-use Exception;
 use Faker\Generator;
 
 class TokenLoginModel extends LoginModel
@@ -13,8 +12,6 @@ class TokenLoginModel extends LoginModel
 
     /**
      * Generate a fake login for testing
-     *
-     * @throws Exception
      */
     public function fake(Generator &$faker): Login
     {

diff --git a/src/Models/UserModel.php b/src/Models/UserModel.php
@@ -2,14 +2,13 @@
 
 namespace CodeIgniter\Shield\Models;
 
-use CodeIgniter\Database\Database;
 use CodeIgniter\Database\Exceptions\DataException;
 use CodeIgniter\Model;
 use CodeIgniter\Shield\Authentication\Authenticators\Session;
 use CodeIgniter\Shield\Entities\User;
+use CodeIgniter\Shield\Exceptions\InvalidArgumentException;
 use CodeIgniter\Shield\Exceptions\RuntimeException;
 use Faker\Generator;
-use InvalidArgumentException;
 
 class UserModel extends Model
 {