feature #210 Strong typed function params and return types (michnovka)

This PR was merged into the 2.x-dev branch. Discussion ---------- Strong typed function params and return types Ive reviewed bridges and added typed return types and params Commits ------- 58e0449 Add return types and param types to bridge functions. Minor phpdoc fixes Do not use deprecated getVarcharTypeDeclarationSQL if newer getStringTypeDeclarationSQL is present
Elao · Dec 15, 2022 · d6d138b · d6d138b
2 parents dce599d + 58e0449
commit d6d138b
Show file tree

Hide file tree

Showing 13 changed files with 27 additions and 29 deletions.
diff --git a/Makefile b/Makefile
@@ -1,7 +1,7 @@
 include .make/help.mk
 include .make/text.mk
 
-PHP_CS_FIXER_VERSION=v3.9.4
+PHP_CS_FIXER_VERSION=v3.13.0
 
 ###########
 # Install #

diff --git a/src/Bridge/Doctrine/Common/AbstractTypesDumper.php b/src/Bridge/Doctrine/Common/AbstractTypesDumper.php
@@ -17,7 +17,7 @@
  */
 abstract class AbstractTypesDumper
 {
-    public function dumpToFile(string $file, array $types)
+    public function dumpToFile(string $file, array $types): void
     {
         file_put_contents($file, $this->dump($types));
     }

diff --git a/src/Bridge/Doctrine/DBAL/Types/AbstractEnumType.php b/src/Bridge/Doctrine/DBAL/Types/AbstractEnumType.php
@@ -48,10 +48,8 @@ protected function onNullFromPhp(): int|string|null
      * {@inheritdoc}
      *
      * @param \BackedEnum|null $value
-     *
-     * @return mixed
      */
-    public function convertToDatabaseValue($value, AbstractPlatform $platform)
+    public function convertToDatabaseValue($value, AbstractPlatform $platform): string|int|null
     {
         if ($value !== null && !$value instanceof \BackedEnum) {
             throw new InvalidArgumentException(sprintf(
@@ -72,10 +70,8 @@ public function convertToDatabaseValue($value, AbstractPlatform $platform)
      * {@inheritdoc}
      *
      * @param int|string|null $value The value to convert.
-     *
-     * @return \BackedEnum|null
      */
-    public function convertToPHPValue($value, AbstractPlatform $platform)
+    public function convertToPHPValue($value, AbstractPlatform $platform): ?\BackedEnum
     {
         if (null === $value) {
             return $this->onNullFromDatabase();
@@ -87,11 +83,15 @@ public function convertToPHPValue($value, AbstractPlatform $platform)
     /**
      * {@inheritdoc}
      */
-    public function getSQLDeclaration(array $fieldDeclaration, AbstractPlatform $platform): string
+    public function getSQLDeclaration(array $column, AbstractPlatform $platform): string
     {
         return $this->isIntBackedEnum()
-            ? $platform->getIntegerTypeDeclarationSQL($fieldDeclaration)
-            : $platform->getVarcharTypeDeclarationSQL($fieldDeclaration)
+            ? $platform->getIntegerTypeDeclarationSQL($column)
+            : (
+                method_exists($platform, 'getStringTypeDeclarationSQL') ?
+                $platform->getStringTypeDeclarationSQL($column) :
+                $platform->getVarcharTypeDeclarationSQL($column)
+            )
         ;
     }
 
@@ -113,10 +113,8 @@ public function getBindingType(): int
 
     /**
      * Cast the value from database to proper enumeration internal type.
-     *
-     * @param int|string $value
      */
-    private function cast($value): int|string
+    private function cast(int|string $value): int|string
     {
         return $this->isIntBackedEnum() ? (int) $value : (string) $value;
     }

diff --git a/src/Bridge/Symfony/Bundle/DependencyInjection/Compiler/DoctrineDBALTypesPass.php b/src/Bridge/Symfony/Bundle/DependencyInjection/Compiler/DoctrineDBALTypesPass.php
@@ -18,15 +18,14 @@
 
 class DoctrineDBALTypesPass implements CompilerPassInterface
 {
-    /** @var string */
-    private $typesFilePath;
+    private string $typesFilePath;
 
     public function __construct(string $typesFilePath)
     {
         $this->typesFilePath = $typesFilePath;
     }
 
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->hasParameter('.elao_enum.doctrine_types')) {
             return;

diff --git a/src/Bridge/Symfony/Bundle/DependencyInjection/Compiler/DoctrineODMTypesPass.php b/src/Bridge/Symfony/Bundle/DependencyInjection/Compiler/DoctrineODMTypesPass.php
@@ -18,15 +18,14 @@
 
 class DoctrineODMTypesPass implements CompilerPassInterface
 {
-    /** @var string */
-    private $typesFilePath;
+    private string $typesFilePath;
 
     public function __construct(string $typesFilePath)
     {
         $this->typesFilePath = $typesFilePath;
     }
 
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->hasParameter('.elao_enum.doctrine_mongodb_types')) {
             return;

diff --git a/src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php b/src/Bridge/Symfony/Bundle/DependencyInjection/Configuration.php
@@ -30,7 +30,7 @@ public function getConfigTreeBuilder(): TreeBuilder
         return $treeBuilder;
     }
 
-    private function addDoctrineDbalSection(ArrayNodeDefinition $rootNode)
+    private function addDoctrineDbalSection(ArrayNodeDefinition $rootNode): void
     {
         $rootNode->children()
             ->arrayNode('doctrine')
@@ -97,7 +97,7 @@ private function addDoctrineDbalSection(ArrayNodeDefinition $rootNode)
         ->end();
     }
 
-    private function addDoctrineOdmSection(ArrayNodeDefinition $rootNode)
+    private function addDoctrineOdmSection(ArrayNodeDefinition $rootNode): void
     {
         $rootNode->children()
             ->arrayNode('doctrine_mongodb')

diff --git a/src/Bridge/Symfony/Bundle/DependencyInjection/ElaoEnumExtension.php b/src/Bridge/Symfony/Bundle/DependencyInjection/ElaoEnumExtension.php
@@ -23,7 +23,7 @@
 
 class ElaoEnumExtension extends Extension implements PrependExtensionInterface
 {
-    public function prepend(ContainerBuilder $container)
+    public function prepend(ContainerBuilder $container): void
     {
         $loader = new PhpFileLoader($container, new FileLocator(__DIR__ . '/../config'));
         $loader->load('services.php');
@@ -42,7 +42,7 @@ public function prepend(ContainerBuilder $container)
         }
     }
 
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $config = $this->processConfiguration($this->getConfiguration($configs, $container), $configs);
 

diff --git a/src/Bridge/Symfony/Bundle/ElaoEnumBundle.php b/src/Bridge/Symfony/Bundle/ElaoEnumBundle.php
@@ -19,7 +19,7 @@
 
 class ElaoEnumBundle extends Bundle
 {
-    public function build(ContainerBuilder $container)
+    public function build(ContainerBuilder $container): void
     {
         parent::build($container);
 

diff --git a/src/Bridge/Symfony/Form/DataTransformer/AbstractFlagBagTransformer.php b/src/Bridge/Symfony/Form/DataTransformer/AbstractFlagBagTransformer.php
@@ -23,7 +23,7 @@ abstract class AbstractFlagBagTransformer implements DataTransformerInterface
     /** @var class-string<\BackedEnum> */
     protected string $enumType;
 
-    /** @var class-string<\BackedEnum> */
+    /** @param class-string<\BackedEnum> $enumType */
     public function __construct(string $enumType)
     {
         if (!is_a($enumType, \BackedEnum::class, true)) {

diff --git a/src/Bridge/Symfony/Form/Type/EnumType.php b/src/Bridge/Symfony/Form/Type/EnumType.php
@@ -25,7 +25,7 @@ class EnumType extends AbstractType
     /**
      * {@inheritdoc}
      */
-    public function configureOptions(OptionsResolver $resolver)
+    public function configureOptions(OptionsResolver $resolver): void
     {
         $resolver
             // Override the original type logic for label for readable enums.

diff --git a/src/Bridge/Symfony/Form/Type/FlagBagType.php b/src/Bridge/Symfony/Form/Type/FlagBagType.php
@@ -23,7 +23,7 @@
  */
 class FlagBagType extends AbstractType
 {
-    public function buildForm(FormBuilderInterface $builder, array $options)
+    public function buildForm(FormBuilderInterface $builder, array $options): void
     {
         if (!$options['multiple']) {
             throw new InvalidConfigurationException(sprintf(
@@ -38,7 +38,7 @@ public function buildForm(FormBuilderInterface $builder, array $options)
     /**
      * {@inheritdoc}
      */
-    public function configureOptions(OptionsResolver $resolver)
+    public function configureOptions(OptionsResolver $resolver): void
     {
         $resolver
             ->setDefault('multiple', true)

diff --git a/src/FlagBag.php b/src/FlagBag.php
@@ -19,6 +19,7 @@
  * A bag of {@see \BackedEnum} allowing to perform bit operations.
  *
  * @final
+ *
  * @template T of \BackedEnum
  */
 class FlagBag

diff --git a/src/ReadableEnumInterface.php b/src/ReadableEnumInterface.php
@@ -20,6 +20,7 @@ interface ReadableEnumInterface extends \UnitEnum
      * Gets human representations per enum cases.
      *
      * @return iterable labels indexed by enum cases
+     *
      * @psalm-return iterable<ReadableEnumInterface, string>
      */
     public static function readables(): iterable;