zlikavac32/php-enum-doctrine

Doctrine PHP enum support

0.6.0 2020-04-13 02:10 UTC

Requires

• php: ^7.4
• doctrine/dbal: ^2.10
• zlikavac32/php-enum: ^3.0

Requires (Dev)

• doctrine/orm: ^2.7
• phpunit/phpunit: ^8.2

MIT

• Marijan Šuflaj

• doctrine
• enum
• enumeration
• php-enum
• doctrine-enum

README

Doctrine support for zlikavac32/php-enum.

Table of contents

1. Installation
2. Usage
   1. Custom column length
   2. Custom representation
3. Limitations
4. Further work

Installation

Recommended installation is through Composer.

composer require zlikavac32/php-enum-doctrine

Usage

Assumption is that there exists a valid enum \YesNoEnum.

Create a new type that extends \Zlikavac32\DoctrineEnum\DBAL\Types\EnumType.

use Zlikavac32\DoctrineEnum\DBAL\Types\EnumType;

class YesNoEnumType extends EnumType 
{
    // ...
}

Next, define protected function enumClass(): string. This method should return FQN of the enum class that this type exposes to the Doctrine.

protected function enumClass(): string
{
    return \YesNoEnum::class;
}

Define Doctrine method public function getName(): string that defines type's name.

public function getName(): string
{
    return 'enum_yes_no';
}

And that's it. Only thing left to do is to register the type using

\Doctrine\DBAL\Types\Type::addType('enum_yes_no', \YesNoEnumType::class);

You can now use enum_yes_no type.

/**
 * @Column(type="enum_yes_no", nullable=true)
 * @var \YesNoEnum|null
 */
private $yesNo;

For more info on the custom Doctrine mapping types, check official documentation.

Custom column length

Internally this library uses varchar type with the maximum length of 32. If you want to fit the length to your own needs, just override method protected function columnLength(): int.

protected function columnLength(): int
{
    return 16;
}

Note that on types first usage, all enum elements names are checked against specified column length. If a name longer than maximum length is detected, a \LogicException is thrown.

Custom representation

By default, name of the enum element is used for it's representation in the database. To change that behaviour, override methods enumToDatabaseValue() and databaseValueToEnum().

Limitations

This library does not use platform dependent types like enum in MySQL or custom types in PostgresSQL. Instead, varchar is used.

Reasons for this are:

• Doctrine can not diff enum contents because that's types intrinsic property
• for PostgresSQL we can't diff column because type is not in Doctrine control
• column constraints can not be used because they break ALTER syntax

If you know how to avoid any of this, please let me know.

Further work

Figure out how to overcome issues in Limitations.