heymoon/doctrine-psql-enum

Store PHP8.1 native enums as PostgeSQL custom enum types

1.0.0 2023-09-24 14:47 UTC

Requires

• php: >=8.1
• doctrine/doctrine-bundle: 2.*
• doctrine/orm: 2.*
• symfony/framework-bundle: 6.*

Requires (Dev)

• doctrine/doctrine-migrations-bundle: 3.*
• phpunit/phpunit: ^9.5
• symfony/orm-pack: 2.*
• symfony/yaml: 6.*

MIT

• Egor

• postgresql
• enum
• doctrine-orm

README

Prerequisites: Symfony 6 + Doctrine 2

Installation

composer require heymoon/doctrine-psql-enum

Usage

Create library configuration:

config/packages/doctrine_postgres_enum.yaml

doctrine_postgres_enum:
  type_name: enum
  migrations:
    enabled: true
    comment_tag: DC2Enum

For defining new enum type, use native PHP enums:

enum AuthStatus: string
{
    case New = 'new';
    case Active = 'active';
    case Inactive = 'inactive';
    case Deleted = 'deleted';
}

enum Service: string
{
    case Google = 'google';
}

For creation of enum-field in model, use enum as type value, enumType in Column attribute must be defined:

#[ORM\Entity(repositoryClass: AuthRepository::class)]
class Auth
{
    #[ORM\Id]
    #[ORM\GeneratedValue(strategy: "CUSTOM")]
    #[ORM\CustomIdGenerator(class: "doctrine.uuid_generator")]
    #[ORM\Column(type: 'uuid')]
    private Uuid $id;

    #[ORM\Column(type: 'enum', enumType: AuthStatus::class)]
    private AuthStatus $status;

    #[ORM\Column(type: 'enum', enumType: Service::class)]
    private Service $service;
}

Create migrations via make:migration. If enum was created or modified, the CREATE TYPE/ALTER TYPE calls would be added to migration. Example:

$this->addSql('DROP TYPE IF EXISTS app_entity_type_authstatus');
$this->addSql('CREATE TYPE app_entity_type_authstatus AS ENUM (\'new\',\'active\',\'inactive\',\'deleted\')');
$this->addSql('DROP TYPE IF EXISTS app_entity_type_service');
$this->addSql('CREATE TYPE app_entity_type_service AS ENUM (\'google\')');
$this->addSql('CREATE TABLE auth (id UUID NOT NULL, status app_entity_type_authstatus NOT NULL, service app_entity_type_service NOT NULL, PRIMARY KEY(id))');
$this->addSql('COMMENT ON COLUMN auth.status IS \'(DC2Enum:App\\Entity\\Type\\AuthStatus)\'');
$this->addSql('COMMENT ON COLUMN auth.service IS \'(DC2Enum:App\\Entity\\Type\\Service)\'');