EnumTypeGuesser.php

<?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\Form;

use Doctrine\Persistence\ManagerRegistry;
use Fresh\DoctrineEnumBundle\DBAL\Types\AbstractEnumType;
use Fresh\DoctrineEnumBundle\Exception\EnumType\EnumTypeIsRegisteredButClassDoesNotExistException;
use JetBrains\PhpStorm\Pure;
use Symfony\Bridge\Doctrine\Form\DoctrineOrmTypeGuesser;
use Symfony\Component\Form\Extension\Core\Type\ChoiceType;
use Symfony\Component\Form\Guess\Guess;
use Symfony\Component\Form\Guess\TypeGuess;

/**
 * EnumTypeGuesser.
 *
 * @author Artem Henvald <genvaldartem@gmail.com>
 * @author Jaik Dean <jaik@fluoresce.co>
 */
class EnumTypeGuesser extends DoctrineOrmTypeGuesser
{
    /** @var string[] */
    private array $registeredEnumTypes = [];

    /**
     * @param ManagerRegistry                      $registry
     * @param array<string, array<string, string>> $registeredTypes
     */
    #[Pure]
    public function __construct(ManagerRegistry $registry, array $registeredTypes)
    {
        parent::__construct($registry);

        foreach ($registeredTypes as $type => $details) {
            $this->registeredEnumTypes[$type] = $details['class'];
        }
    }

    /**
     * @template T of object
     *
     * @param class-string<T> $class
     * @param string          $property
     *
     * @throws EnumTypeIsRegisteredButClassDoesNotExistException
     *
     * @return TypeGuess|null
     */
    public function guessType(string $class, string $property): ?TypeGuess
    {
        $classMetadata = $this->getMetadata($class);

        // If no metadata for this class - can't guess anything
        if (!$classMetadata) {
            return null;
        }

        /** @var \Doctrine\ORM\Mapping\ClassMetadata<object> $metadata */
        [$metadata] = $classMetadata;
        $fieldType = $metadata->getTypeOfField($property);

        // This is not one of the registered ENUM types
        if (!\is_string($fieldType) || !isset($this->registeredEnumTypes[$fieldType])) {
            return null;
        }

        $registeredEnumTypeFQCN = $this->registeredEnumTypes[$fieldType];

        if (!\class_exists($registeredEnumTypeFQCN)) {
            $exceptionMessage = \sprintf(
                'ENUM type "%s" is registered as "%s", but that class does not exist',
                $fieldType,
                $registeredEnumTypeFQCN
            );

            throw new EnumTypeIsRegisteredButClassDoesNotExistException($exceptionMessage);
        }

        if (!\is_subclass_of($registeredEnumTypeFQCN, AbstractEnumType::class)) {
            return null;
        }

        /** @var AbstractEnumType<int|string, int|string> $registeredEnumTypeFQCN */
        $parameters = [
            'choices' => $registeredEnumTypeFQCN::getChoices(), // Get the choices from the fully qualified class name
            'required' => !$metadata->isNullable($property),
        ];

        return new TypeGuess(ChoiceType::class, $parameters, Guess::VERY_HIGH_CONFIDENCE);
    }
}