Merge pull request #765 from driehle/coding-standards

Updated to doctrine-coding-standard v12
doctrine · Dec 30, 2024 · 422e5ba · 422e5ba
2 parents 232a92a + 7b8a56c
commit 422e5ba
Show file tree

Hide file tree

Showing 63 changed files with 242 additions and 480 deletions.
diff --git a/composer.json b/composer.json
@@ -30,7 +30,7 @@
     },
     "require-dev": {
         "doctrine/annotations": "^2.0.0",
-        "doctrine/coding-standard": "^9.0.0",
+        "doctrine/coding-standard": "^12.0.0",
         "doctrine/data-fixtures": "^1.5.2",
         "doctrine/migrations": "^3.8.0",
         "laminas/laminas-cache-storage-adapter-filesystem": "^2.0",

diff --git a/src/CliConfigurator.php b/src/CliConfigurator.php
@@ -59,11 +59,8 @@ class CliConfigurator
         'doctrine.migrations_cmd.uptodate',
     ];
 
-    private ContainerInterface $container;
-
-    public function __construct(ContainerInterface $container)
+    public function __construct(private ContainerInterface $container)
     {
-        $this->container = $container;
     }
 
     public function configure(Application $cli): void
@@ -84,9 +81,7 @@ public function configure(Application $cli): void
         }
     }
 
-    /**
-     * @return array<string,Helper>
-     */
+    /** @return array<string,Helper> */
     private function getHelpers(EntityManagerInterface $objectManager): array
     {
         return [
@@ -102,7 +97,7 @@ private function createObjectManagerInputOption(): InputOption
             null,
             InputOption::VALUE_OPTIONAL,
             'The name of the object manager to use.',
-            $this->defaultObjectManagerName
+            $this->defaultObjectManagerName,
         );
     }
 
@@ -117,9 +112,7 @@ private function getObjectManagerName(): string
         return $arguments->getParameterOption('--object-manager');
     }
 
-    /**
-     * @return string[]
-     */
+    /** @return string[] */
     private function getAvailableCommands(): array
     {
         if (class_exists(VersionCommand::class)) {

diff --git a/src/Collector/MappingCollector.php b/src/Collector/MappingCollector.php
@@ -22,17 +22,14 @@ class MappingCollector implements CollectorInterface, AutoHideInterface
      */
     public const PRIORITY = 10;
 
-    protected string $name;
-
-    protected ?ClassMetadataFactory $classMetadataFactory = null;
+    protected ClassMetadataFactory|null $classMetadataFactory = null;
 
     /** @var ClassMetadata[] indexed by class name */
     protected array $classes = [];
 
-    public function __construct(ClassMetadataFactory $classMetadataFactory, string $name)
+    public function __construct(ClassMetadataFactory $classMetadataFactory, protected string $name)
     {
         $this->classMetadataFactory = $classMetadataFactory;
-        $this->name                 = $name;
     }
 
     public function getName(): string
@@ -67,9 +64,7 @@ public function canHide(): bool
         return empty($this->classes);
     }
 
-    /**
-     * @return array{name: string, classes: ClassMetadata[]}
-     */
+    /** @return array{name: string, classes: ClassMetadata[]} */
     public function __serialize(): array
     {
         return [
@@ -78,18 +73,14 @@ public function __serialize(): array
         ];
     }
 
-    /**
-     * @param array{name: string, classes: ClassMetadata[]} $data
-     */
+    /** @param array{name: string, classes: ClassMetadata[]} $data */
     public function __unserialize(array $data): void
     {
         $this->name    = $data['name'];
         $this->classes = $data['classes'];
     }
 
-    /**
-     * @return ClassMetadata[]
-     */
+    /** @return ClassMetadata[] */
     public function getClasses(): array
     {
         return $this->classes;

diff --git a/src/Collector/SQLLoggerCollector.php b/src/Collector/SQLLoggerCollector.php
@@ -21,14 +21,8 @@ class SQLLoggerCollector implements CollectorInterface, AutoHideInterface
      */
     public const PRIORITY = 10;
 
-    protected DebugStack $sqlLogger;
-
-    protected string $name;
-
-    public function __construct(DebugStack $sqlLogger, string $name)
+    public function __construct(protected DebugStack $sqlLogger, protected string $name)
     {
-        $this->sqlLogger = $sqlLogger;
-        $this->name      = $name;
     }
 
     public function getName(): string
@@ -55,9 +49,7 @@ public function getQueryCount(): int
         return count($this->sqlLogger->queries);
     }
 
-    /**
-     * @return mixed[]
-     */
+    /** @return mixed[] */
     public function getQueries(): array
     {
         return $this->sqlLogger->queries;

diff --git a/src/ConfigProvider.php b/src/ConfigProvider.php
@@ -9,9 +9,7 @@
  */
 final class ConfigProvider
 {
-    /**
-     * @return mixed[]
-     */
+    /** @return mixed[] */
     public function __invoke(): array
     {
         $config                 = include __DIR__ . '/../config/module.config.php';

diff --git a/src/Form/Annotation/DoctrineAnnotationListener.php b/src/Form/Annotation/DoctrineAnnotationListener.php
@@ -19,11 +19,8 @@
 
 class DoctrineAnnotationListener extends AbstractListenerAggregate
 {
-    protected ObjectManager $objectManager;
-
-    public function __construct(ObjectManager $objectManager)
+    public function __construct(protected ObjectManager $objectManager)
     {
-        $this->objectManager = $objectManager;
     }
 
     /**
@@ -33,45 +30,43 @@ public function attach(EventManagerInterface $events, $priority = 1)
     {
         $this->listeners[] = $events->attach(
             EntityBasedFormBuilder::EVENT_CONFIGURE_FIELD,
-            [$this, 'handleFilterField']
+            [$this, 'handleFilterField'],
         );
         $this->listeners[] = $events->attach(
             EntityBasedFormBuilder::EVENT_CONFIGURE_FIELD,
-            [$this, 'handleTypeField']
+            [$this, 'handleTypeField'],
         );
         $this->listeners[] = $events->attach(
             EntityBasedFormBuilder::EVENT_CONFIGURE_FIELD,
-            [$this, 'handleValidatorField']
+            [$this, 'handleValidatorField'],
         );
         $this->listeners[] = $events->attach(
             EntityBasedFormBuilder::EVENT_CONFIGURE_FIELD,
-            [$this, 'handleRequiredField']
+            [$this, 'handleRequiredField'],
         );
         $this->listeners[] = $events->attach(
             EntityBasedFormBuilder::EVENT_EXCLUDE_FIELD,
-            [$this, 'handleExcludeField']
+            [$this, 'handleExcludeField'],
         );
         $this->listeners[] = $events->attach(
             EntityBasedFormBuilder::EVENT_CONFIGURE_ASSOCIATION,
-            [$this, 'handleToOne']
+            [$this, 'handleToOne'],
         );
         $this->listeners[] = $events->attach(
             EntityBasedFormBuilder::EVENT_CONFIGURE_ASSOCIATION,
-            [$this, 'handleToMany']
+            [$this, 'handleToMany'],
         );
         $this->listeners[] = $events->attach(
             EntityBasedFormBuilder::EVENT_CONFIGURE_ASSOCIATION,
-            [$this, 'handleRequiredAssociation']
+            [$this, 'handleRequiredAssociation'],
         );
         $this->listeners[] = $events->attach(
             EntityBasedFormBuilder::EVENT_EXCLUDE_ASSOCIATION,
-            [$this, 'handleExcludeAssociation']
+            [$this, 'handleExcludeAssociation'],
         );
     }
 
-    /**
-     * @internal
-     */
+    /** @internal */
     public function handleToOne(EventInterface $event): void
     {
         $metadata = $event->getParam('metadata');
@@ -84,9 +79,7 @@ public function handleToOne(EventInterface $event): void
         $this->mergeAssociationOptions($event->getParam('elementSpec'), $mapping['targetEntity']);
     }
 
-    /**
-     * @internal
-     */
+    /** @internal */
     public function handleToMany(EventInterface $event): void
     {
         $metadata = $event->getParam('metadata');
@@ -106,19 +99,15 @@ public function handleToMany(EventInterface $event): void
         $elementSpec['spec']['attributes']['multiple'] = true;
     }
 
-    /**
-     * @internal
-     */
+    /** @internal */
     public function handleExcludeAssociation(EventInterface $event): bool
     {
         $metadata = $event->getParam('metadata');
 
         return $metadata && $metadata->isAssociationInverseSide($event->getParam('name'));
     }
 
-    /**
-     * @internal
-     */
+    /** @internal */
     public function handleExcludeField(EventInterface $event): bool
     {
         $metadata    = $event->getParam('metadata');
@@ -128,9 +117,7 @@ public function handleExcludeField(EventInterface $event): bool
             $metadata->generatorType === ClassMetadata::GENERATOR_TYPE_IDENTITY;
     }
 
-    /**
-     * @internal
-     */
+    /** @internal */
     public function handleFilterField(EventInterface $event): void
     {
         $metadata = $event->getParam('metadata');
@@ -165,9 +152,7 @@ public function handleFilterField(EventInterface $event): void
         }
     }
 
-    /**
-     * @internal
-     */
+    /** @internal */
     public function handleRequiredAssociation(EventInterface $event): void
     {
         $metadata = $event->getParam('metadata');
@@ -206,9 +191,7 @@ public function handleRequiredAssociation(EventInterface $event): void
         }
     }
 
-    /**
-     * @internal
-     */
+    /** @internal */
     public function handleRequiredField(EventInterface $event): void
     {
         $this->prepareEvent($event);
@@ -223,9 +206,7 @@ public function handleRequiredField(EventInterface $event): void
         $inputSpec['required'] = ! $metadata->isNullable($event->getParam('name'));
     }
 
-    /**
-     * @internal
-     */
+    /** @internal */
     public function handleTypeField(EventInterface $event): void
     {
         $metadata = $event->getParam('metadata');
@@ -281,9 +262,7 @@ public function handleTypeField(EventInterface $event): void
         $elementSpec['spec']['type'] = $type;
     }
 
-    /**
-     * @internal
-     */
+    /** @internal */
     public function handleValidatorField(EventInterface $event): void
     {
         $mapping = $this->getFieldMapping($event);
@@ -333,10 +312,8 @@ public function handleValidatorField(EventInterface $event): void
         }
     }
 
-    /**
-     * @return mixed[]|null
-     */
-    protected function getFieldMapping(EventInterface $event): ?array
+    /** @return mixed[]|null */
+    protected function getFieldMapping(EventInterface $event): array|null
     {
         $metadata = $event->getParam('metadata');
         if ($metadata && $metadata->hasField($event->getParam('name'))) {
@@ -346,10 +323,8 @@ protected function getFieldMapping(EventInterface $event): ?array
         return null;
     }
 
-    /**
-     * @return mixed[]|null
-     */
-    protected function getAssociationMapping(EventInterface $event): ?array
+    /** @return mixed[]|null */
+    protected function getAssociationMapping(EventInterface $event): array|null
     {
         $metadata = $event->getParam('metadata');
         if ($metadata && $metadata->hasAssociation($event->getParam('name'))) {
@@ -367,7 +342,7 @@ protected function mergeAssociationOptions(ArrayObject $elementSpec, string $tar
                 'object_manager' => $this->objectManager,
                 'target_class'   => $targetEntity,
             ],
-            $options
+            $options,
         );
 
         $elementSpec['spec']['options'] = $options;

diff --git a/src/Form/Annotation/EntityBasedFormBuilder.php b/src/Form/Annotation/EntityBasedFormBuilder.php
@@ -34,28 +34,23 @@ final class EntityBasedFormBuilder
 
     protected AbstractBuilder $builder;
 
-    protected ObjectManager $objectManager;
-
     /**
      * Constructor. Ensures ObjectManager is present.
      */
-    public function __construct(ObjectManager $objectManager, ?AbstractBuilder $builder = null)
+    public function __construct(protected ObjectManager $objectManager, AbstractBuilder|null $builder = null)
     {
         if (! class_exists(AbstractBuilder::class)) {
             throw new RuntimeException(sprintf(
                 'Usage of %s requires laminas-form 3.0.0 or newer, which currently is not installed.',
-                self::class
+                self::class,
             ));
         }
 
-        $this->objectManager = $objectManager;
-        $this->builder       = $builder ?? new LaminasAnnotationBuilder();
+        $this->builder = $builder ?? new LaminasAnnotationBuilder();
         (new DoctrineAnnotationListener($this->objectManager))->attach($this->builder->getEventManager());
     }
 
-    /**
-     * @return AbstractBuilder the form builder from laminas-form
-     */
+    /** @return AbstractBuilder the form builder from laminas-form */
     public function getBuilder(): AbstractBuilder
     {
         return $this->builder;

diff --git a/src/Module.php b/src/Module.php
@@ -38,7 +38,7 @@ static function (EventInterface $event): void {
                         ->get(CliConfigurator::class)
                         ->configure($event->getTarget());
                 },
-                1
+                1,
             );
 
         // Initialize logger collector in DeveloperTools
@@ -54,7 +54,7 @@ static function (EventInterface $event): void {
                 static function ($event): void {
                     $container = $event->getTarget()->getParam('ServiceManager');
                     $container->get('doctrine.sql_logger_collector.orm_default');
-                }
+                },
             );
     }