annotations - Using array in the columnDefinition for ENUM in Symfony

Question

When I use the columnDefinition in Symfony to define an ENUM column I need to write the possible values as pain text:

columnDefinition="ENUM('red', 'blue', 'green')"

Because this can cause errors in later stages I want to be able to put an array there:

columnDefinition="ENUM(static::COLORS)"

How can I solve this?

question from:https://stackoverflow.com/questions/65829909/using-array-in-the-columndefinition-for-enum-in-symfony

Answer 1

You can create a Enum as a type and use it

<?php
namespace AppDBAL;



use DoctrineDBALTypesType;
use DoctrineDBALPlatformsAbstractPlatform;

class EnumColorsType extends Type
{

    const ENUM_COLORS = 'enum_colors';
    const COLOR_RED = 'red';
    const COLOR_BLUE = 'blue';
    const COLOR_GREEN= 'green';

    publkic static $AVAILBLE_COLORS = ['blue','red','green']; 

    public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $platform)
    {

        return sprintf("ENUM(%s)",implode(',', static::$AVAILBLE_COLORS));
    }

    public function convertToPHPValue($value, AbstractPlatform $platform)
    {
        return $value;
    }

    public function convertToDatabaseValue($value, AbstractPlatform $platform)
    {
        if (!in_array($value, static::$AVAILBLE_COLORS)) {
            throw new InvalidArgumentException("Invalid Colors");
        }
        return $value;
    }

    public function getName()
    {
        return self::ENUM_COLORS;
    }


    public function requiresSQLCommentHint(AbstractPlatform $platform)
    {
        return true;
    }
}

Then use it

<?php
...
/** 
 * @ORMEntity
 */
class YourEntity
{
    /** 
     * @Column(type="enum_colors") 
     */
    private $color;
}