Skip to content

fix: change hardcoded user entity with declared return type #1105

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
May 4, 2024
Merged

fix: change hardcoded user entity with declared return type #1105

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
fcf0444
change hardcoded user entity with declared return type
MrFrost-Nv27 Apr 23, 2024
d619d04
add error thrown before returning with declared returnType
MrFrost-Nv27 May 2, 2024
b9d0441
change comment and signing commit
MrFrost-Nv27 May 2, 2024
f9d5dd1
signing commit
MrFrost-Nv27 May 2, 2024
34806e5
create checkreturnType method
MrFrost-Nv27 May 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions src/Models/UserModel.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
use CodeIgniter\Shield\Entities\User;
use CodeIgniter\Shield\Entities\UserIdentity;
use CodeIgniter\Shield\Exceptions\InvalidArgumentException;
use CodeIgniter\Shield\Exceptions\LogicException;
use CodeIgniter\Shield\Exceptions\ValidationException;
use Faker\Generator;

Expand Down Expand Up @@ -164,7 +165,9 @@ public function addToDefaultGroup(User $user): void

public function fake(Generator &$faker): User
{
return new User([
$this->checkReturnType();

return new $this->returnType([
'username' => $faker->unique()->userName(),
'active' => true,
]);
Expand Down Expand Up @@ -226,7 +229,9 @@ public function findByCredentials(array $credentials): ?User
$password_hash = $data['password_hash'];
unset($data['password_hash']);

$user = new User($data);
$this->checkReturnType();

$user = new $this->returnType($data);
$user->email = $email;
$user->password_hash = $password_hash;
$user->syncOriginal();
Expand Down Expand Up @@ -383,4 +388,11 @@ public function updateActiveDate(User $user): void
->where('id', $user->id)
->update();
}

private function checkReturnType(): void
{
if (! is_a($this->returnType, User::class, true)) {
throw new LogicException('Return type must be a subclass of ' . User::class);
}
}
}