Skip to content

Commit 06793ad

Browse files
arhimedearhimede
authored
Merge pull request #300 from dotkernel/issue-212
Issue #212: Implemented enums in database
2 parents a4f1216 + 2fc7a92 commit 06793ad

33 files changed

+341
-158
lines changed

‎composer.json‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,8 @@
7272
"psr-4": {
7373
"Admin\\App\\": "src/App/src/",
7474
"Admin\\Admin\\": "src/Admin/src/",
75-
"Admin\\Setting\\": "src/Setting/src/"
75+
"Admin\\Setting\\": "src/Setting/src/",
76+
"Admin\\Fixtures\\": "data/doctrine/fixtures"
7677
}
7778
},
7879
"autoload-dev": {

‎config/autoload/authentication.global.php‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
'doctrine' => [
99
'authentication' => [
1010
'orm_default' => [
11-
'object_manager' => 'doctrine.entitymanager.orm_default',
11+
'object_manager' => 'doctrine.entity_manager.orm_default',
1212
'identity_class' => Admin::class,
1313
'identity_property' => 'identity',
1414
'credential_property' => 'password',

‎config/autoload/doctrine.global.php‎

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,9 @@
22

33
declare(strict_types=1);
44

5+
use Admin\Admin\DBAL\Types\AdminStatusEnumType;
6+
use Admin\App\DBAL\Types\SuccessFailureEnumType;
7+
use Admin\App\DBAL\Types\YesNoEnumType;
58
use Admin\App\Resolver\EntityListenerResolver;
69
use Doctrine\Persistence\Mapping\Driver\MappingDriverChain;
710
use Dot\Cache\Adapter\ArrayAdapter;
@@ -11,7 +14,17 @@
1114
use Ramsey\Uuid\Doctrine\UuidType;
1215

1316
return [
14-
'doctrine' => [
17+
'doctrine' => [
18+
'cache' => [
19+
'array' => [
20+
'class' => ArrayAdapter::class,
21+
],
22+
'filesystem' => [
23+
'class' => FilesystemAdapter::class,
24+
'directory' => getcwd() . '/data/cache',
25+
'namespace' => 'doctrine',
26+
],
27+
],
1528
'configuration' => [
1629
'orm_default' => [
1730
'entity_listener_resolver' => EntityListenerResolver::class,
@@ -49,17 +62,11 @@
4962
UuidType::NAME => UuidType::class,
5063
UuidBinaryType::NAME => UuidBinaryType::class,
5164
UuidBinaryOrderedTimeType::NAME => UuidBinaryOrderedTimeType::class,
52-
],
53-
'cache' => [
54-
'array' => [
55-
'class' => ArrayAdapter::class,
56-
],
57-
'filesystem' => [
58-
'class' => FilesystemAdapter::class,
59-
'directory' => getcwd() . '/data/cache',
60-
'namespace' => 'doctrine',
61-
],
65+
AdminStatusEnumType::NAME => AdminStatusEnumType::class,
66+
SuccessFailureEnumType::NAME => SuccessFailureEnumType::class,
67+
YesNoEnumType::NAME => YesNoEnumType::class,
6268
],
6369
'fixtures' => getcwd() . '/data/doctrine/fixtures',
6470
],
71+
'resultCacheLifetime' => 600,
6572
];

‎config/cli-config.php‎

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,4 @@
1313

1414
$entityManager = $container->get(EntityManager::class);
1515

16-
// register enum type for doctrine
17-
$entityManager->getConnection()->getDatabasePlatform()->registerDoctrineTypeMapping('enum', 'string');
18-
1916
return DependencyFactory::fromEntityManager($config, new ExistingEntityManager($entityManager));

‎data/doctrine/fixtures/AdminLoader.php‎

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@
1010
use Doctrine\Common\DataFixtures\FixtureInterface;
1111
use Doctrine\Persistence\ObjectManager;
1212

13+
use function assert;
1314
use function password_hash;
1415

1516
use const PASSWORD_DEFAULT;
@@ -18,14 +19,15 @@ class AdminLoader implements FixtureInterface, DependentFixtureInterface
1819
{
1920
public function load(ObjectManager $manager): void
2021
{
22+
$role = $manager->getRepository(AdminRole::class)->findOneBy(['name' => AdminRole::ROLE_SUPERUSER]);
23+
assert($role instanceof AdminRole);
24+
2125
$admin = (new Admin())
2226
->setIdentity('admin')
2327
->setPassword(password_hash('dotadmin', PASSWORD_DEFAULT))
2428
->setFirstName('DotKernel')
2529
->setLastName('Admin')
26-
->addRole(
27-
$manager->getRepository(AdminRole::class)->findOneBy(['name' => AdminRole::ROLE_SUPERUSER])
28-
);
30+
->addRole($role);
2931

3032
$manager->persist($admin);
3133
$manager->flush();

data/doctrine/migrations/Version20240627134952.php renamed to data/doctrine/migrations/Version20241120150458.php

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
/**
1111
* Auto-generated Migration: Please modify to your needs!
1212
*/
13-
final class Version20240627134952 extends AbstractMigration
13+
final class Version20241120150458 extends AbstractMigration
1414
{
1515
public function getDescription(): string
1616
{
@@ -20,11 +20,11 @@ public function getDescription(): string
2020
public function up(Schema $schema): void
2121
{
2222
// this up() migration is auto-generated, please modify it to your needs
23-
$this->addSql('CREATE TABLE admin (uuid BINARY(16) NOT NULL, identity VARCHAR(100) NOT NULL, firstName VARCHAR(255) DEFAULT NULL, lastName VARCHAR(255) DEFAULT NULL, password VARCHAR(100) NOT NULL, status ENUM(\'pending\', \'active\'), created DATETIME NOT NULL, updated DATETIME DEFAULT NULL, UNIQUE INDEX UNIQ_880E0D766A95E9C4 (identity), PRIMARY KEY(uuid)) DEFAULT CHARACTER SET utf8mb4');
23+
$this->addSql('CREATE TABLE admin (identity VARCHAR(100) NOT NULL, firstName VARCHAR(255) DEFAULT NULL, lastName VARCHAR(255) DEFAULT NULL, password VARCHAR(100) NOT NULL, status ENUM(\'active\', \'inactive\') DEFAULT \'active\' NOT NULL, uuid BINARY(16) NOT NULL, created DATETIME NOT NULL, updated DATETIME DEFAULT NULL, UNIQUE INDEX UNIQ_880E0D766A95E9C4 (identity), PRIMARY KEY(uuid)) DEFAULT CHARACTER SET utf8mb4');
2424
$this->addSql('CREATE TABLE admin_roles (userUuid BINARY(16) NOT NULL, roleUuid BINARY(16) NOT NULL, INDEX IDX_1614D53DD73087E9 (userUuid), INDEX IDX_1614D53D88446210 (roleUuid), PRIMARY KEY(userUuid, roleUuid)) DEFAULT CHARACTER SET utf8mb4');
25-
$this->addSql('CREATE TABLE admin_login (uuid BINARY(16) NOT NULL, adminIp VARCHAR(50) DEFAULT NULL, country VARCHAR(50) DEFAULT NULL, continent VARCHAR(50) DEFAULT NULL, organization VARCHAR(50) DEFAULT NULL, deviceType VARCHAR(20) DEFAULT NULL, deviceBrand VARCHAR(20) DEFAULT NULL, deviceModel VARCHAR(40) DEFAULT NULL, isMobile ENUM(\'yes\', \'no\'), osName VARCHAR(20) DEFAULT NULL, osVersion VARCHAR(20) DEFAULT NULL, osPlatform VARCHAR(20) DEFAULT NULL, clientType VARCHAR(20) DEFAULT NULL, clientName VARCHAR(40) DEFAULT NULL, clientEngine VARCHAR(20) DEFAULT NULL, clientVersion VARCHAR(20) DEFAULT NULL, loginStatus ENUM(\'success\', \'fail\'), identity VARCHAR(100) DEFAULT NULL, created DATETIME NOT NULL, updated DATETIME DEFAULT NULL, PRIMARY KEY(uuid)) DEFAULT CHARACTER SET utf8mb4');
26-
$this->addSql('CREATE TABLE admin_role (uuid BINARY(16) NOT NULL, name VARCHAR(30) NOT NULL, created DATETIME NOT NULL, updated DATETIME DEFAULT NULL, UNIQUE INDEX UNIQ_7770088A5E237E06 (name), PRIMARY KEY(uuid)) DEFAULT CHARACTER SET utf8mb4');
27-
$this->addSql('CREATE TABLE settings (uuid BINARY(16) NOT NULL, identifier VARCHAR(50) NOT NULL, value LONGTEXT NOT NULL, created DATETIME NOT NULL, updated DATETIME DEFAULT NULL, admin_uuid BINARY(16) DEFAULT NULL, INDEX IDX_E545A0C5F166D246 (admin_uuid), PRIMARY KEY(uuid)) DEFAULT CHARACTER SET utf8mb4');
25+
$this->addSql('CREATE TABLE admin_login (adminIp VARCHAR(50) DEFAULT NULL, country VARCHAR(50) DEFAULT NULL, continent VARCHAR(50) DEFAULT NULL, organization VARCHAR(50) DEFAULT NULL, deviceType VARCHAR(20) DEFAULT NULL, deviceBrand VARCHAR(20) DEFAULT NULL, deviceModel VARCHAR(40) DEFAULT NULL, isMobile ENUM(\'yes\', \'no\') NOT NULL, osName VARCHAR(20) DEFAULT NULL, osVersion VARCHAR(20) DEFAULT NULL, osPlatform VARCHAR(20) DEFAULT NULL, clientType VARCHAR(20) DEFAULT NULL, clientName VARCHAR(40) DEFAULT NULL, clientEngine VARCHAR(20) DEFAULT NULL, clientVersion VARCHAR(20) DEFAULT NULL, loginStatus ENUM(\'success\', \'failure\') NOT NULL, identity VARCHAR(100) DEFAULT NULL, uuid BINARY(16) NOT NULL, created DATETIME NOT NULL, updated DATETIME DEFAULT NULL, PRIMARY KEY(uuid)) DEFAULT CHARACTER SET utf8mb4');
26+
$this->addSql('CREATE TABLE admin_role (name VARCHAR(30) NOT NULL, uuid BINARY(16) NOT NULL, created DATETIME NOT NULL, updated DATETIME DEFAULT NULL, UNIQUE INDEX UNIQ_7770088A5E237E06 (name), PRIMARY KEY(uuid)) DEFAULT CHARACTER SET utf8mb4');
27+
$this->addSql('CREATE TABLE settings (identifier VARCHAR(50) NOT NULL, value LONGTEXT NOT NULL, uuid BINARY(16) NOT NULL, created DATETIME NOT NULL, updated DATETIME DEFAULT NULL, admin_uuid BINARY(16) DEFAULT NULL, INDEX IDX_E545A0C5F166D246 (admin_uuid), PRIMARY KEY(uuid)) DEFAULT CHARACTER SET utf8mb4');
2828
$this->addSql('ALTER TABLE admin_roles ADD CONSTRAINT FK_1614D53DD73087E9 FOREIGN KEY (userUuid) REFERENCES admin (uuid)');
2929
$this->addSql('ALTER TABLE admin_roles ADD CONSTRAINT FK_1614D53D88446210 FOREIGN KEY (roleUuid) REFERENCES admin_role (uuid)');
3030
$this->addSql('ALTER TABLE settings ADD CONSTRAINT FK_E545A0C5F166D246 FOREIGN KEY (admin_uuid) REFERENCES admin (uuid)');

‎src/Admin/src/Controller/AdminController.php‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
use Admin\Admin\Adapter\AuthenticationAdapter;
88
use Admin\Admin\Entity\Admin;
99
use Admin\Admin\Entity\AdminIdentity;
10-
use Admin\Admin\Entity\AdminLogin;
10+
use Admin\Admin\Enum\AdminStatusEnum;
1111
use Admin\Admin\Form\AccountForm;
1212
use Admin\Admin\Form\AdminDeleteForm;
1313
use Admin\Admin\Form\AdminForm;
@@ -17,6 +17,7 @@
1717
use Admin\Admin\InputFilter\EditAdminInputFilter;
1818
use Admin\Admin\Service\AdminServiceInterface;
1919
use Admin\App\Common\ServerRequestAwareTrait;
20+
use Admin\App\Enum\SuccessFailureEnum;
2021
use Admin\App\Exception\IdentityException;
2122
use Admin\App\Message;
2223
use Admin\App\Pagination;
@@ -269,9 +270,9 @@ public function loginAction(): ResponseInterface
269270
$this->adminService->logAdminVisit(
270271
$this->getServerParams(),
271272
$data['username'],
272-
AdminLogin::LOGIN_SUCCESS
273+
SuccessFailureEnum::Success
273274
);
274-
if ($identity->getStatus() === Admin::STATUS_INACTIVE) {
275+
if ($identity->getStatus() === AdminStatusEnum::Inactive) {
275276
$this->authenticationService->clearIdentity();
276277
$this->messenger->addError('Admin is inactive', 'user-login');
277278
$this->messenger->addData('shouldRebind', true);
@@ -285,7 +286,7 @@ public function loginAction(): ResponseInterface
285286
$this->adminService->logAdminVisit(
286287
$this->getServerParams(),
287288
$data['username'],
288-
AdminLogin::LOGIN_FAIL
289+
SuccessFailureEnum::Failure
289290
);
290291
$this->messenger->addData('shouldRebind', true);
291292
$this->forms->saveState($form);
@@ -449,7 +450,7 @@ public function simpleLoginsAction(): ResponseInterface
449450
'params' => $params,
450451
'logins' => $logins['rows'],
451452
'settings' => $settings?->getValue() ?? [],
452-
'statuses' => [AdminLogin::LOGIN_FAIL, AdminLogin::LOGIN_SUCCESS],
453+
'statuses' => SuccessFailureEnum::cases(),
453454
'identities' => $this->adminService->getAdminLoginIdentities(),
454455
'identifier' => Setting::IDENTIFIER_TABLE_ADMIN_LIST_LOGINS_SELECTED_COLUMNS,
455456
'pagination' => new Pagination($logins['total'], $params['offset'], $params['limit']),

‎src/Admin/src/DBAL/Types/AdminStatusEnumType.php‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace Admin\Admin\DBAL\Types;
6+
7+
use Admin\Admin\Enum\AdminStatusEnum;
8+
use Admin\App\DBAL\Types\AbstractEnumType;
9+
10+
class AdminStatusEnumType extends AbstractEnumType
11+
{
12+
public const NAME = 'admin_status_enum';
13+
14+
protected function getEnumClass(): string
15+
{
16+
return AdminStatusEnum::class;
17+
}
18+
19+
public function getName(): string
20+
{
21+
return self::NAME;
22+
}
23+
}

‎src/Admin/src/Entity/Admin.php‎

Lines changed: 6 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
namespace Admin\Admin\Entity;
66

7+
use Admin\Admin\Enum\AdminStatusEnum;
78
use Admin\Admin\Repository\AdminRepository;
89
use Admin\App\Entity\AbstractEntity;
910
use Admin\App\Entity\TimestampsTrait;
@@ -23,13 +24,6 @@ class Admin extends AbstractEntity implements AdminInterface
2324
{
2425
use TimestampsTrait;
2526

26-
public const STATUS_ACTIVE = 'active';
27-
public const STATUS_INACTIVE = 'pending';
28-
public const STATUSES = [
29-
self::STATUS_ACTIVE,
30-
self::STATUS_INACTIVE,
31-
];
32-
3327
#[ORM\Column(name: "identity", type: "string", length: 100, unique: true)]
3428
protected string $identity;
3529

@@ -42,22 +36,16 @@ class Admin extends AbstractEntity implements AdminInterface
4236
#[ORM\Column(name: "password", type: "string", length: 100)]
4337
protected string $password;
4438

45-
#[ORM\Column(
46-
name: "status",
47-
type: "string",
48-
length: 20,
49-
nullable: false,
50-
columnDefinition: "ENUM('pending', 'active')"
51-
)]
52-
protected string $status = self::STATUS_ACTIVE;
39+
#[ORM\Column(type: "admin_status_enum", options: ["default" => AdminStatusEnum::Active])]
40+
protected AdminStatusEnum $status = AdminStatusEnum::Active;
5341

5442
#[ORM\ManyToMany(targetEntity: AdminRole::class, fetch: "EAGER")]
5543
#[ORM\JoinTable(name: "admin_roles")]
5644
#[ORM\JoinColumn(name: "userUuid", referencedColumnName: "uuid")]
5745
#[ORM\InverseJoinColumn(name: "roleUuid", referencedColumnName: "uuid")]
5846
protected Collection $roles;
5947

60-
#[ORM\OneToMany(mappedBy: 'admin', targetEntity: Setting::class)]
48+
#[ORM\OneToMany(targetEntity: Setting::class, mappedBy: 'admin')]
6149
protected Collection $settings;
6250

6351
public function __construct()
@@ -137,12 +125,12 @@ public function verifyPassword(string $password): bool
137125
return password_verify($password, $this->getPassword());
138126
}
139127

140-
public function getStatus(): string
128+
public function getStatus(): AdminStatusEnum
141129
{
142130
return $this->status;
143131
}
144132

145-
public function setStatus(string $status): self
133+
public function setStatus(AdminStatusEnum $status): self
146134
{
147135
$this->status = $status;
148136

‎src/Admin/src/Entity/AdminIdentity.php‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,15 @@
44

55
namespace Admin\Admin\Entity;
66

7+
use Admin\Admin\Enum\AdminStatusEnum;
78
use Mezzio\Authentication\UserInterface;
89

910
class AdminIdentity implements UserInterface
1011
{
1112
public function __construct(
1213
protected string $uuid,
1314
protected string $identity,
14-
protected string $status,
15+
protected AdminStatusEnum $status,
1516
protected array $roles = [],
1617
protected array $details = []
1718
) {
@@ -27,7 +28,7 @@ public function getIdentity(): string
2728
return $this->identity;
2829
}
2930

30-
public function getStatus(): string
31+
public function getStatus(): AdminStatusEnum
3132
{
3233
return $this->status;
3334
}

0 commit comments

Comments
 (0)