Merge pull request #622 from kenjis/refactor-UserIdentityModel-update

refactor: UserIdentityModel::update() throws Exception

Author: kenjis

src/Models/UserIdentityModel.php

@@ -13,6 +13,7 @@
 use CodeIgniter\Shield\Entities\User;
 use CodeIgniter\Shield\Entities\UserIdentity;
 use CodeIgniter\Shield\Exceptions\LogicException;
+use CodeIgniter\Shield\Exceptions\ValidationException;
 use Faker\Generator;
 
 class UserIdentityModel extends Model
@@ -362,6 +363,26 @@ public function forceGlobalPasswordReset(): void
         $this->checkQueryReturn($return);
     }
 
+    /**
+     * Override the Model's `update()` method.
+     * Throws an Exception when it fails.
+     *
+     * @param array|int|string|null $id
+     * @param array|object|null     $data
+     *
+     * @return true if the update is successful
+     *
+     * @throws ValidationException
+     */
+    public function update($id = null, $data = null): bool
+    {
+        $result = parent::update($id, $data);
+
+        $this->checkQueryReturn($result);
+
+        return true;
+    }
+
     public function fake(Generator &$faker): UserIdentity
     {
         return new UserIdentity([

src/Traits/Resettable.php

@@ -19,8 +19,8 @@ trait Resettable
      */
     public function requiresPasswordReset(): bool
     {
-        $identity_model = model(UserIdentityModel::class);
-        $identity       = $identity_model->getIdentityByType($this, Session::ID_TYPE_EMAIL_PASSWORD);
+        $identityModel = model(UserIdentityModel::class);
+        $identity      = $identityModel->getIdentityByType($this, Session::ID_TYPE_EMAIL_PASSWORD);
 
         return $identity->force_reset;
     }
@@ -35,11 +35,7 @@ public function forcePasswordReset(): void
             return;
         }
 
-        // Set force_reset to true
-        $identity_model = model(UserIdentityModel::class);
-        $identity_model->set('force_reset', 1);
-        $identity_model->where(['user_id' => $this->id, 'type' => Session::ID_TYPE_EMAIL_PASSWORD]);
-        $identity_model->update();
+        $this->setForceReset(true);
     }
 
     /**
@@ -52,10 +48,19 @@ public function undoForcePasswordReset(): void
             return;
         }
 
-        // Set force_reset to false
-        $identity_model = model(UserIdentityModel::class);
-        $identity_model->set('force_reset', 0);
-        $identity_model->where(['user_id' => $this->id, 'type' => Session::ID_TYPE_EMAIL_PASSWORD]);
-        $identity_model->update();
+        $this->setForceReset(false);
+    }
+
+    /**
+     * Set force_reset
+     */
+    private function setForceReset(bool $value): void
+    {
+        $value = (int) $value;
+
+        $identityModel = model(UserIdentityModel::class);
+        $identityModel->set('force_reset', $value);
+        $identityModel->where(['user_id' => $this->id, 'type' => Session::ID_TYPE_EMAIL_PASSWORD]);
+        $identityModel->update();
     }
 }