EnumType.php

Go to the documentation of this file.

<?php
 
namespace Wikimedia\Rdbms;
 
use Doctrine\DBAL\Platforms\AbstractPlatform;
use Doctrine\DBAL\Types\Type;
use InvalidArgumentException;
 
class EnumType extends Type {
    public const ENUM = 'mwenum';
 
    public function getSQLDeclaration( array $column, AbstractPlatform $platform ) {
        // SQLite does not support ENUM type
        if ( $platform->getName() == 'sqlite' ) {
            return 'TEXT';
        }
 
        // PostgreSQL does support but needs custom handling.
        // This just returns a string name that references the
        // actual ENUM which will be created by CREATE TYPE command
        // If 'fixed' option is not passed, this field will use TEXT
        if ( $platform->getName() == 'postgresql' ) {
            if ( !$column['fixed'] ) {
                return 'TEXT';
            }
 
            return strtoupper( $column['name'] . '_enum' );
        }
 
        if ( $platform->getName() == 'mysql' ) {
            $enumValues = $this->formatValues( $column['enum_values'] );
            return "ENUM( $enumValues )";
        }
    }
 
    public function makeEnumTypeSql( $column, $platform ) {
        if ( $platform->getName() !== 'postgresql' ) {
            throw new InvalidArgumentException(
                __METHOD__ . ' can only be called on Postgres platform'
            );
        }
 
        $enumName = strtoupper( $column['name'] . '_enum' );
        $enumValues = $this->formatValues( $column['enum_values'] );
        $typeSql = "\n\nCREATE TYPE $enumName AS ENUM( $enumValues )";
 
        return $typeSql;
    }
 
    public function formatValues( $values ) {
        $values = implode( "','", $values );
        $enumValues = "'" . $values . "'";
 
        return $enumValues;
    }
 
    public function getName() {
        return self::ENUM;
    }
}