Merge pull request #706 from driehle/feature/static-analysis

Improved types and make static analysis more strict

Author: driehle

phpstan.neon

@@ -1,10 +1,14 @@
 parameters:
-    level: 5
+    level: 6
     paths:
         - src
         - tests
+    checkGenericClassInNonGenericObjectType: false
     treatPhpDocTypesAsCertain: false
     ignoreErrors:
+        -
+            message: '#Method .*EntityBasedFormBuilder::createForm\(\) .* iterable type .*FormInterface#'
+            path: src/Form/Annotation/EntityBasedFormBuilder.php
         -
             message: '#Offset class-string<object> on array\{\} in isset\(\) does not exist#'
             path: src/Yuml/MetadataGrapher.php

psalm.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <psalm
-    errorLevel="5"
+    errorLevel="4"
     phpVersion="8.0"
     resolveFromConfigFile="true"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

src/Collector/MappingCollector.php

@@ -32,29 +32,20 @@ class MappingCollector implements CollectorInterface, AutoHideInterface
     public function __construct(ClassMetadataFactory $classMetadataFactory, string $name)
     {
         $this->classMetadataFactory = $classMetadataFactory;
-        $this->name                 = (string) $name;
+        $this->name                 = $name;
     }
 
-    /**
-     * {@inheritDoc}
-     */
-    public function getName()
+    public function getName(): string
     {
         return $this->name;
     }
 
-    /**
-     * {@inheritDoc}
-     */
-    public function getPriority()
+    public function getPriority(): int
     {
         return self::PRIORITY;
     }
 
-    /**
-     * {@inheritDoc}
-     */
-    public function collect(MvcEvent $mvcEvent)
+    public function collect(MvcEvent $mvcEvent): void
     {
         if (! $this->classMetadataFactory) {
             return;
@@ -71,10 +62,7 @@ public function collect(MvcEvent $mvcEvent)
         ksort($this->classes);
     }
 
-    /**
-     * {@inheritDoc}
-     */
-    public function canHide()
+    public function canHide(): bool
     {
         return empty($this->classes);
     }

src/Collector/SQLLoggerCollector.php

@@ -28,36 +28,24 @@ class SQLLoggerCollector implements CollectorInterface, AutoHideInterface
     public function __construct(DebugStack $sqlLogger, string $name)
     {
         $this->sqlLogger = $sqlLogger;
-        $this->name      = (string) $name;
+        $this->name      = $name;
     }
 
-    /**
-     * {@inheritDoc}
-     */
-    public function getName()
+    public function getName(): string
     {
         return $this->name;
     }
 
-    /**
-     * {@inheritDoc}
-     */
-    public function getPriority()
+    public function getPriority(): int
     {
         return self::PRIORITY;
     }
 
-    /**
-     * {@inheritDoc}
-     */
-    public function collect(MvcEvent $mvcEvent)
+    public function collect(MvcEvent $mvcEvent): void
     {
     }
 
-    /**
-     * {@inheritDoc}
-     */
-    public function canHide()
+    public function canHide(): bool
     {
         return empty($this->sqlLogger->queries);
     }

src/Form/Annotation/EntityBasedFormBuilder.php

@@ -136,7 +136,7 @@ public function getFormSpecification($entity): ArrayObject
     /**
      * Create a form from an object.
      *
-     * @param  class-string|object $entity
+     * @param class-string|object $entity
      */
     public function createForm($entity): FormInterface
     {

src/Module.php

@@ -9,6 +9,7 @@
 use Laminas\ModuleManager\Feature\ConfigProviderInterface;
 use Laminas\ModuleManager\Feature\ControllerProviderInterface;
 use Laminas\ModuleManager\Feature\DependencyIndicatorInterface;
+use Laminas\ModuleManager\Feature\InitProviderInterface;
 use Laminas\ModuleManager\ModuleManagerInterface;
 
 use function class_exists;
@@ -19,12 +20,10 @@
 class Module implements
     ControllerProviderInterface,
     ConfigProviderInterface,
-    DependencyIndicatorInterface
+    DependencyIndicatorInterface,
+    InitProviderInterface
 {
-    /**
-     * {@inheritDoc}
-     */
-    public function init(ModuleManagerInterface $manager)
+    public function init(ModuleManagerInterface $manager): void
     {
         // Initialize the console
         $manager
@@ -60,24 +59,30 @@ static function ($event): void {
 
     /**
      * {@inheritDoc}
+     *
+     * @return array<array-key,mixed>
      */
-    public function getConfig()
+    public function getConfig(): array
     {
         return include __DIR__ . '/../config/module.config.php';
     }
 
     /**
      * {@inheritDoc}
+     *
+     * @return array<array-key,mixed>
      */
-    public function getControllerConfig()
+    public function getControllerConfig(): array
     {
         return include __DIR__ . '/../config/controllers.config.php';
     }
 
     /**
      * {@inheritDoc}
+     *
+     * @return array<string>
      */
-    public function getModuleDependencies()
+    public function getModuleDependencies(): array
     {
         return ['DoctrineModule'];
     }

src/Options/Configuration.php

@@ -537,7 +537,7 @@ public function getRepositoryFactory()
      */
     public function setClassMetadataFactoryName(string $factoryName): self
     {
-        $this->classMetadataFactoryName = (string) $factoryName;
+        $this->classMetadataFactoryName = $factoryName;
 
         return $this;
     }
@@ -612,7 +612,7 @@ public function getFilterSchemaAssetsExpression(): ?string
      */
     public function setDefaultRepositoryClassName(string $className): self
     {
-        $this->defaultRepositoryClassName = (string) $className;
+        $this->defaultRepositoryClassName = $className;
 
         return $this;
     }

src/Options/DBALConnection.php

@@ -105,7 +105,7 @@ public function getParams(): array
      */
     public function setDoctrineTypeMappings(array $doctrineTypeMappings): DBALConnection
     {
-        $this->doctrineTypeMappings = (array) $doctrineTypeMappings;
+        $this->doctrineTypeMappings = $doctrineTypeMappings;
 
         return $this;
     }

src/Options/EntityManager.php

@@ -56,7 +56,7 @@ public function getConnection(): string
 
     public function setEntityResolver(string $entityResolver): self
     {
-        $this->entityResolver = (string) $entityResolver;
+        $this->entityResolver = $entityResolver;
 
         return $this;
     }

src/Options/SQLLoggerCollectorOptions.php

@@ -35,20 +35,20 @@ public function getName(): string
 
     public function setConfiguration(?string $configuration): void
     {
-        $this->configuration = $configuration ? (string) $configuration : null;
+        $this->configuration = $configuration ?: null;
     }
 
     /**
      * Configuration service name (where to set the logger)
      */
     public function getConfiguration(): string
     {
-        return $this->configuration ? $this->configuration : 'doctrine.configuration.orm_default';
+        return $this->configuration ?: 'doctrine.configuration.orm_default';
     }
 
     public function setSqlLogger(?string $sqlLogger): void
     {
-        $this->sqlLogger = $sqlLogger ? (string) $sqlLogger : null;
+        $this->sqlLogger = $sqlLogger ?: null;
     }
 
     /**