Improve AbstractEnumType Types | Enable PHPStan-Doctrine Usage (#196)

.gitignore

@@ -1 +1,3 @@
 /vendor/
+.phpunit.result.cache
+composer.lock

Command/EnumDropCommentCommand.php

@@ -159,7 +159,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
             $io->title(\sprintf('Dropping comments for <info>%s</info> type...', $this->enumType));
 
-            /** @var \Doctrine\ORM\Mapping\ClassMetadata[] $allMetadata */
+            /** @var \Doctrine\ORM\Mapping\ClassMetadata<object>[] $allMetadata */
             $allMetadata = $this->em->getMetadataFactory()->getAllMetadata();
 
             if (!empty($allMetadata)) {

DBAL/Types/AbstractEnumType.php

@@ -29,14 +29,16 @@
  * @author Artem Henvald <genvaldartem@gmail.com>
  * @author Ben Davies <ben.davies@gmail.com>
  * @author Jaik Dean <jaik@fluoresce.co>
+ *
+ * @template T
  */
 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
+     * @var array<T, T> Array of ENUM Values, where ENUM values are keys and their readable versions are values
      *
      * @static
      */
@@ -46,6 +48,8 @@ abstract class AbstractEnumType extends Type
      * {@inheritdoc}
      *
      * @throws InvalidArgumentException
+     *
+     * @return T|null
      */
     public function convertToDatabaseValue($value, AbstractPlatform $platform)
     {
@@ -62,6 +66,8 @@ public function convertToDatabaseValue($value, AbstractPlatform $platform)
 
     /**
      * {@inheritdoc}
+     *
+     * @return T|null
      */
     public function convertToPHPValue($value, AbstractPlatform $platform)
     {
@@ -73,7 +79,7 @@ public function convertToPHPValue($value, AbstractPlatform $platform)
         $choice = static::$choices[$value];
         $choices = \array_flip(static::$choices);
         if (\is_int($choices[$choice])) {
-            return (int) $value;
+            return (int) $value; // @phpstan-ignore-line T can be int
         }
 
         return $value;
@@ -167,7 +173,7 @@ public static function getValues(): array
      *
      * @static
      *
-     * @return int|string
+     * @return T
      */
     public static function getRandomValue()
     {
@@ -192,7 +198,7 @@ public static function getReadableValues(): array
     /**
      * Asserts that given choice exists in the array of ENUM values.
      *
-     * @param mixed $value ENUM value
+     * @param int|string $value ENUM value
      *
      * @throws InvalidArgumentException
      */
@@ -206,11 +212,11 @@ public static function assertValidChoice($value): void
     /**
      * Get value in readable format.
      *
-     * @param mixed $value ENUM value
+     * @param int|string $value ENUM value
      *
      * @static
      *
-     * @return mixed Value in readable format
+     * @return T Value in readable format
      */
     public static function getReadableValue($value)
     {
@@ -220,9 +226,9 @@ public static function getReadableValue($value)
     }
 
     /**
-     * Check if some string value exists in the array of ENUM values.
+     * Check if some value exists in the array of ENUM values.
      *
-     * @param mixed $value ENUM value
+     * @param int|string $value ENUM value
      *
      * @static
      *

DBAL/Types/DayOfWeekFullNameType.php

@@ -16,6 +16,8 @@
  * DayOfWeekFullNameType.
  *
  * @author Artem Henvald <genvaldartem@gmail.com>
+ *
+ * @extends AbstractEnumType<string>
  */
 final class DayOfWeekFullNameType extends AbstractEnumType
 {

DBAL/Types/DayOfWeekShortNameType.php

@@ -16,6 +16,8 @@
  * DayOfWeekShortNameType.
  *
  * @author Artem Henvald <genvaldartem@gmail.com>
+ *
+ * @extends AbstractEnumType<string>
  */
 final class DayOfWeekShortNameType extends AbstractEnumType
 {

DBAL/Types/MonthFullNameType.php

@@ -16,6 +16,8 @@
  * MonthFullNameType.
  *
  * @author Artem Henvald <genvaldartem@gmail.com>
+ *
+ * @extends AbstractEnumType<string>
  */
 final class MonthFullNameType extends AbstractEnumType
 {

DBAL/Types/MonthShortNameType.php

@@ -16,6 +16,8 @@
  * MonthShortNameType.
  *
  * @author Artem Henvald <genvaldartem@gmail.com>
+ *
+ * @extends AbstractEnumType<string>
  */
 final class MonthShortNameType extends AbstractEnumType
 {

Form/EnumTypeGuesser.php

@@ -61,7 +61,7 @@ public function guessType(string $class, string $property): ?TypeGuess
             return null;
         }
 
-        /** @var \Doctrine\ORM\Mapping\ClassMetadataInfo $metadata */
+        /** @var \Doctrine\ORM\Mapping\ClassMetadataInfo<object> $metadata */
         [$metadata] = $classMetadata;
         $fieldType = $metadata->getTypeOfField($property);
 
@@ -86,7 +86,7 @@ public function guessType(string $class, string $property): ?TypeGuess
             return null;
         }
 
-        /** @var AbstractEnumType $registeredEnumTypeFQCN */
+        /** @var AbstractEnumType<int|string> $registeredEnumTypeFQCN */
         $parameters = [
             'choices' => $registeredEnumTypeFQCN::getChoices(), // Get the choices from the fully qualified class name
             'required' => !$metadata->isNullable($property),

Tests/Fixtures/DBAL/Types/AbstractParentType.php

@@ -18,6 +18,10 @@
  * AbstractParentType.
  *
  * @author Arturs Vonda <github@artursvonda.lv>
+ *
+ * @template T of int|string
+ *
+ * @extends AbstractEnumType<T>
  */
 abstract class AbstractParentType extends AbstractEnumType
 {

Tests/Fixtures/DBAL/Types/BasketballPositionType.php

@@ -18,6 +18,8 @@
  * BasketballPositionType.
  *
  * @author Artem Henvald <genvaldartem@gmail.com>
+ *
+ * @extends AbstractEnumType<string>
  */
 final class BasketballPositionType extends AbstractEnumType
 {

Tests/Fixtures/DBAL/Types/InheritedType.php

@@ -16,6 +16,8 @@
  * InheritedType.
  *
  * @author Arturs Vonda <github@artursvonda.lv>
+ *
+ * @extends AbstractParentType<string>
  */
 final class InheritedType extends AbstractParentType
 {

Tests/Fixtures/DBAL/Types/MapLocationType.php

@@ -18,6 +18,8 @@
  * MapLocationType.
  *
  * @author Artem Henvald <genvaldartem@gmail.com>
+ *
+ * @extends AbstractEnumType<string>
  */
 final class MapLocationType extends AbstractEnumType
 {

Tests/Fixtures/DBAL/Types/NumericType.php

@@ -18,6 +18,8 @@
  * NumericType.
  *
  * @author Stephan Vock <stephan.vock@gmail.com>
+ *
+ * @extends AbstractEnumType<int>
  */
 final class NumericType extends AbstractEnumType
 {

Tests/Fixtures/DBAL/Types/StubType.php

@@ -18,6 +18,8 @@
  * StubType.
  *
  * @author Artem Henvald <genvaldartem@gmail.com>
+ *
+ * @extends AbstractEnumType<string>
  */
 final class StubType extends AbstractEnumType
 {

Tests/Fixtures/DBAL/Types/TaskStatusType.php

@@ -18,6 +18,8 @@
  * TaskStatusType.
  *
  * @author Artem Henvald <genvaldartem@gmail.com>
+ *
+ * @extends AbstractEnumType<string>
  */
 final class TaskStatusType extends AbstractEnumType
 {

Tests/Twig/Extension/ReadableEnumValueTwigExtensionTest.php

@@ -18,6 +18,7 @@
 use Fresh\DoctrineEnumBundle\Exception\EnumValue\ValueIsNotFoundInAnyRegisteredEnumTypeException;
 use Fresh\DoctrineEnumBundle\Tests\Fixtures\DBAL\Types\BasketballPositionType;
 use Fresh\DoctrineEnumBundle\Tests\Fixtures\DBAL\Types\MapLocationType;
+use Fresh\DoctrineEnumBundle\Tests\Fixtures\DBAL\Types\NumericType;
 use Fresh\DoctrineEnumBundle\Twig\Extension\ReadableEnumValueTwigExtension;
 use PHPUnit\Framework\TestCase;
 use Twig\TwigFilter;
@@ -37,6 +38,7 @@ protected function setUp(): void
         $this->readableEnumValueTwigExtension = new ReadableEnumValueTwigExtension([
             'BasketballPositionType' => ['class' => BasketballPositionType::class],
             'MapLocationType' => ['class' => MapLocationType::class],
+            'NumericType' => ['class' => NumericType::class],
         ]);
     }
 
@@ -56,11 +58,11 @@ public function testGetFilters(): void
     /**
      * @dataProvider dataProviderForGetReadableEnumValueTest
      *
-     * @param string|null $expectedReadableValue
-     * @param string|null $enumValue
+     * @param int|string|null $expectedReadableValue
+     * @param int|string|null $enumValue
      * @param string|null $enumType
      */
-    public function testGetReadableEnumValue(?string $expectedReadableValue, ?string $enumValue, ?string $enumType): void
+    public function testGetReadableEnumValue($expectedReadableValue, $enumValue, ?string $enumType): void
     {
         self::assertEquals(
             $expectedReadableValue,
@@ -75,6 +77,8 @@ public static function dataProviderForGetReadableEnumValueTest(): iterable
         yield ['Center', BasketballPositionType::CENTER, 'BasketballPositionType'];
         yield ['Center', MapLocationType::CENTER, 'MapLocationType'];
         yield [null, null, 'MapLocationType'];
+        yield [1, NumericType::ONE, 'NumericType'];
+        yield [1, NumericType::ONE, null];
     }
 
     public function testEnumTypeIsNotRegisteredException(): void

Twig/Extension/AbstractEnumTwigExtension.php

@@ -24,10 +24,10 @@
  */
 abstract class AbstractEnumTwigExtension extends AbstractExtension
 {
-    /** @var string[]|AbstractEnumType[] */
+    /** @var string[]|AbstractEnumType<int|string>[] */
     protected $registeredEnumTypes = [];
 
-    /** @var string[]|AbstractEnumType[] */
+    /** @var string[]|AbstractEnumType<int|string>[] */
     protected $occurrences = [];
 
     /**

Twig/Extension/EnumConstantTwigExtension.php

@@ -12,6 +12,7 @@
 
 namespace Fresh\DoctrineEnumBundle\Twig\Extension;
 
+use Fresh\DoctrineEnumBundle\DBAL\Types\AbstractEnumType;
 use Fresh\DoctrineEnumBundle\Exception\Constant\ConstantIsFoundInFewRegisteredEnumTypesException;
 use Fresh\DoctrineEnumBundle\Exception\Constant\ConstantIsNotFoundInAnyRegisteredEnumTypeException;
 use Fresh\DoctrineEnumBundle\Exception\EnumType\EnumTypeIsNotRegisteredException;
@@ -88,7 +89,7 @@ public function getEnumConstant(string $enumConstant, ?string $enumType = null):
      */
     private function findOccurrences(string $enumConstant): void
     {
-        /** @var class-string<\Fresh\DoctrineEnumBundle\DBAL\Types\AbstractEnumType> $registeredEnumType */
+        /** @var class-string<AbstractEnumType<int|string>> $registeredEnumType */
         foreach ($this->registeredEnumTypes as $registeredEnumType) {
             $reflection = new \ReflectionClass($registeredEnumType);
 

Twig/Extension/ReadableEnumValueTwigExtension.php

@@ -35,17 +35,17 @@ public function getFilters(): array
     }
 
     /**
-     * @param string|null $enumValue
-     * @param string|null $enumType
+     * @param int|string|null $enumValue
+     * @param string|null     $enumType
      *
      * @throws EnumTypeIsNotRegisteredException
      * @throws NoRegisteredEnumTypesException
      * @throws ValueIsFoundInFewRegisteredEnumTypesException
      * @throws ValueIsNotFoundInAnyRegisteredEnumTypeException
      *
-     * @return string|null
+     * @return int|string|null
      */
-    public function getReadableEnumValue(?string $enumValue, ?string $enumType = null): ?string
+    public function getReadableEnumValue($enumValue, ?string $enumType = null)
     {
         if ($this->hasRegisteredEnumTypes()) {
             if (null === $enumValue) {
@@ -91,9 +91,9 @@ public function getReadableEnumValue(?string $enumValue, ?string $enumType = nul
     }
 
     /**
-     * @param string $enumValue
+     * @param int|string $enumValue
      */
-    private function findOccurrences(string $enumValue): void
+    private function findOccurrences($enumValue): void
     {
         foreach ($this->registeredEnumTypes as $registeredEnumType) {
             if ($registeredEnumType::isValueExist($enumValue)) {

Validator/Constraints/Enum.php

@@ -24,7 +24,7 @@
  */
 class Enum extends Choice
 {
-    /** @var string|AbstractEnumType */
+    /** @var string|AbstractEnumType<int|string> */
     public $entity;
 
     /**
@@ -35,7 +35,7 @@ public function __construct($options = null)
         $this->strict = true;
 
         if (isset($options['entity'])) {
-            /** @var AbstractEnumType $entity */
+            /** @var AbstractEnumType<int|string> $entity */
             $entity = $options['entity'];
 
             if (\is_subclass_of($entity, AbstractEnumType::class)) {

phpstan.neon

@@ -11,4 +11,3 @@ parameters:
         - '%rootDir%/../../../vendor/*'
     fileExtensions:
         - 'php'
-    checkGenericClassInNonGenericObjectType: false