Fresh\DoctrineEnumBundle\DBAL\Types\AbstractEnumType

Complexity

Total Complexity

25

Size/Duplication

Total Lines	230
Duplicated Lines	2.61 %

Coupling/Cohesion

Components	1
Dependencies	3

Importance

Changes

0

14 Methods

Rating	Name	Duplication	Size	Complexity
A	convertToDatabaseValue()	3	12	3
A	convertToPHPValue()	0	15	3
A	getSqlDeclaration()	0	33	5
A	requiresSQLCommentHint()	0	4	1
A	getName()	0	4	2
A	getChoices()	0	4	1
A	getValues()	0	4	1
A	getRandomValue()	0	7	1
A	getReadableValues()	0	4	1
A	getReadableValue()	0	6	1
A	isValueExist()	0	4	1
A	getDefaultValue()	0	4	1
A	getMappedDatabaseTypes()	0	8	2
A	assertValidChoice()	3	6	2

<?php
/*
 * This file is part of the FreshDoctrineEnumBundle.
 *
 * (c) Artem Henvald <genvaldartem@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

declare(strict_types=1);

namespace Fresh\DoctrineEnumBundle\DBAL\Types;

use Doctrine\DBAL\Platforms\AbstractPlatform;
use Doctrine\DBAL\Platforms\MySqlPlatform;
use Doctrine\DBAL\Platforms\PostgreSQL100Platform;
use Doctrine\DBAL\Platforms\SqlitePlatform;
use Doctrine\DBAL\Platforms\SQLServer2012Platform;
use Doctrine\DBAL\Types\Type;
use Fresh\DoctrineEnumBundle\Exception\InvalidArgumentException;

/**
 * AbstractEnumType.
 *
 * Provides support of ENUM type for Doctrine in Symfony applications.
 *
 * @author Artem Henvald <genvaldartem@gmail.com>
 * @author Ben Davies <ben.davies@gmail.com>
 * @author Jaik Dean <jaik@fluoresce.co>
 */
abstract class AbstractEnumType extends Type
{
    /** @var string */
    protected $name = '';

    /**
     * @var array|mixed[] Array of ENUM Values, where ENUM values are keys and their readable versions are values
     *
     * @static
     */
    protected static $choices = [];

    /**
     * {@inheritdoc}
     *
     * @throws InvalidArgumentException
     */
    public function convertToDatabaseValue($value, AbstractPlatform $platform)
    {
        if (null === $value) {
            return null;
        }

        if (!isset(static::$choices[$value])) {

This code seems to be duplicated across your project.

            throw new InvalidArgumentException(\sprintf('Invalid value "%s" for ENUM "%s".', $value, $this->getName()));
        }

        return $value;
    }

    /**
     * {@inheritdoc}
     */
    public function convertToPHPValue($value, AbstractPlatform $platform)
    {
        if (!isset(static::$choices[$value])) {
            return $value;
        }

        // Check whether choice list is using integers as values
        $choice = static::$choices[$value];
        $choices = \array_flip(static::$choices);
        if (\is_int($choices[$choice])) {
            return (int) $value;
        }

        return $value;
    }

    /**
     * Gets the SQL declaration snippet for a field of this type.
     *
     * @param mixed[]          $fieldDeclaration The field declaration
     * @param AbstractPlatform $platform         The currently used database platform
     *
     * @return string
     */
    public function getSqlDeclaration(array $fieldDeclaration, AbstractPlatform $platform): string
    {
        $values = \implode(
            ', ',
            \array_map(
                static function (string $value) {
                    return "'{$value}'";
                },
                static::getValues()
            )
        );

        switch (true) {
            case $platform instanceof SqlitePlatform:
                $sqlDeclaration = \sprintf('TEXT CHECK(%s IN (%s))', $fieldDeclaration['name'], $values);

                break;
            case $platform instanceof PostgreSQL100Platform:
            case $platform instanceof SQLServer2012Platform:
                $sqlDeclaration = \sprintf('VARCHAR(255) CHECK(%s IN (%s))', $fieldDeclaration['name'], $values);

                break;
            default:
                $sqlDeclaration = \sprintf('ENUM(%s)', $values);
        }

        $defaultValue = static::getDefaultValue();
        if (null !== $defaultValue) {
            $sqlDeclaration .= \sprintf(' DEFAULT %s', $platform->quoteStringLiteral($defaultValue));
        }

        return $sqlDeclaration;
    }

    /**
     * {@inheritdoc}
     */
    public function requiresSQLCommentHint(AbstractPlatform $platform): bool
    {
        return true;
    }

    /**
     * {@inheritdoc}
     */
    public function getName(): string
    {
        return $this->name ?: (string) \array_search(static::class, self::getTypesMap(), true);
    }

    /**
     * Get readable choices for the ENUM field.
     *
     * @static
     *
     * @return mixed[]
     */
    public static function getChoices(): array
    {
        return \array_flip(static::$choices);
    }

    /**
     * Get values for the ENUM field.
     *
     * @static
     *
     * @return mixed[] Values for the ENUM field
     */
    public static function getValues(): array
    {
        return \array_keys(static::$choices);
    }

    /**
     * Get random value for the ENUM field.
     *
     * @static
     *
     * @return int|string
     */
    public static function getRandomValue()
    {
        $values = self::getValues();
        $randomKey = \random_int(0, \count($values) - 1);

        return $values[$randomKey];
    }

    /**
     * Get array of ENUM Values, where ENUM values are keys and their readable versions are values.
     *
     * @static
     *
     * @return mixed[] Array of values in readable format
     */
    public static function getReadableValues(): array
    {
        return static::$choices;
    }

    /**
     * Asserts that given choice exists in the array of ENUM values.
     *
     * @param mixed $value ENUM value
     *
     * @throws InvalidArgumentException
     */
    public static function assertValidChoice($value): void
    {
        if (!isset(static::$choices[$value])) {

This code seems to be duplicated across your project.

            throw new InvalidArgumentException(\sprintf('Invalid value "%s" for ENUM type "%s".', (string) $value, static::class));
        }
    }

    /**
     * Get value in readable format.
     *
     * @param mixed $value ENUM value
     *
     * @static
     *
     * @return mixed Value in readable format
     */
    public static function getReadableValue($value)
    {
        static::assertValidChoice($value);

        return static::$choices[$value];
    }

    /**
     * Check if some string value exists in the array of ENUM values.
     *
     * @param mixed $value ENUM value
     *
     * @static
     *
     * @return bool
     */
    public static function isValueExist($value): bool
    {
        return isset(static::$choices[$value]);
    }

    /**
     * Get default value for DDL statement.
     *
     * @static
     *
     * @return mixed|null Default value for DDL statement
     */
    public static function getDefaultValue()
    {
        return null;
    }

    /**
     * Gets an array of database types that map to this Doctrine type.
     *
     * @param AbstractPlatform $platform
     *
     * @return string[]
     */
    public function getMappedDatabaseTypes(AbstractPlatform $platform): array
    {
        if ($platform instanceof MySqlPlatform) {
            return \array_merge(parent::getMappedDatabaseTypes($platform), ['enum']);
        }

        return parent::getMappedDatabaseTypes($platform);
    }
}