Merge pull request #320 from norkunas/sca

Increase phpstan level to 7

Author: norkunas

BazingaGeocoderBundle.php

@@ -25,6 +25,8 @@ class BazingaGeocoderBundle extends Bundle
 {
     /**
      * {@inheritdoc}
+     *
+     * @return void
      */
     public function build(ContainerBuilder $container)
     {

Command/GeocodeCommand.php

@@ -41,6 +41,8 @@ public function __construct(ProviderAggregator $geocoder)
 
     /**
      * {@inheritdoc}
+     *
+     * @return void
      */
     protected function configure()
     {

DataCollector/GeocoderDataCollector.php

@@ -13,6 +13,8 @@
 namespace Bazinga\GeocoderBundle\DataCollector;
 
 use Bazinga\GeocoderBundle\Plugin\ProfilingPlugin;
+use Geocoder\Collection;
+use Geocoder\Query\Query;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\DataCollector\DataCollector;
@@ -34,7 +36,7 @@ public function __construct()
     }
 
     /**
-     * {@inheritdoc}
+     * @return void
      */
     public function reset()
     {
@@ -45,6 +47,8 @@ public function reset()
 
     /**
      * {@inheritdoc}
+     *
+     * @return void
      */
     public function collect(Request $request, Response $response, \Throwable $exception = null)
     {
@@ -53,7 +57,6 @@ public function collect(Request $request, Response $response, \Throwable $except
             return;
         }
 
-        /** @var ProfilingPlugin[] $instances */
         $instances = $this->instances;
 
         foreach ($instances as $instance) {
@@ -67,6 +70,8 @@ public function collect(Request $request, Response $response, \Throwable $except
 
     /**
      * Returns an array of collected requests.
+     *
+     * @phpstan-return array<int, array{query: Query, queryString: string, duration: float, providerName: string, result: mixed, resultCount: int}>
      */
     public function getQueries(): array
     {
@@ -86,18 +91,27 @@ public function getTotalDuration(): float
         return $time;
     }
 
+    /**
+     * @return string[]
+     */
     public function getProviders(): array
     {
         return $this->data['providers'];
     }
 
+    /**
+     * @phpstan-return array<int, array{query: Query, queryString: string, duration: float, providerName: string, result: mixed, resultCount: int}>
+     */
     public function getProviderQueries(string $provider): array
     {
-        return array_filter($this->data['queries'], function ($data) use ($provider) {
+        return array_filter($this->data['queries'], static function ($data) use ($provider) {
             return $data['providerName'] === $provider;
         });
     }
 
+    /**
+     * @return void
+     */
     public function addInstance(ProfilingPlugin $instance)
     {
         $this->instances[] = $instance;

DependencyInjection/BazingaGeocoderExtension.php

@@ -39,6 +39,11 @@
  */
 class BazingaGeocoderExtension extends Extension
 {
+    /**
+     * @phpstan-param array<mixed, mixed> $configs
+     *
+     * @return void
+     */
     public function load(array $configs, ContainerBuilder $container)
     {
         $processor = new Processor();
@@ -71,6 +76,11 @@ public function load(array $configs, ContainerBuilder $container)
             ->addTag('bazinga_geocoder.dumper');
     }
 
+    /**
+     * @phpstan-param array<mixed, mixed> $config
+     *
+     * @return void
+     */
     private function loadProviders(ContainerBuilder $container, array $config)
     {
         foreach ($config['providers'] as $providerName => $providerConfig) {
@@ -109,6 +119,10 @@ private function loadProviders(ContainerBuilder $container, array $config)
 
     /**
      * Configure plugins for a client.
+     *
+     * @phpstan-param array<mixed, mixed> $config
+     *
+     * @return Reference[]
      */
     public function configureProviderPlugins(ContainerBuilder $container, array $config, string $providerServiceId): array
     {
@@ -173,13 +187,23 @@ public function configureProviderPlugins(ContainerBuilder $container, array $con
     }
 
     /**
+     * @phpstan-param array<mixed, mixed> $config
+     *
      * @return Configuration
      */
     public function getConfiguration(array $config, ContainerBuilder $container)
     {
-        return new Configuration($container->getParameter('kernel.debug'));
+        /** @var bool $debug */
+        $debug = $container->getParameter('kernel.debug');
+
+        return new Configuration($debug);
     }
 
+    /**
+     * @phpstan-param array<mixed, mixed> $options
+     *
+     * @phpstan-return array<mixed, mixed>
+     */
     private function findReferences(array $options): array
     {
         foreach ($options as $key => $value) {

DependencyInjection/Compiler/AddProvidersPass.php

@@ -25,6 +25,8 @@ class AddProvidersPass implements CompilerPassInterface
     /**
      * Get all providers based on their tag (`bazinga_geocoder.provider`) and
      * register them.
+     *
+     * @return void
      */
     public function process(ContainerBuilder $container)
     {

DependencyInjection/Compiler/FactoryValidatorPass.php

@@ -23,10 +23,15 @@
  */
 class FactoryValidatorPass implements CompilerPassInterface
 {
+    /**
+     * @var string[]
+     */
     private static $factoryServiceIds = [];
 
     /**
      * {@inheritdoc}
+     *
+     * @return void
      */
     public function process(ContainerBuilder $container)
     {
@@ -38,10 +43,12 @@ public function process(ContainerBuilder $container)
     }
 
     /**
-     * @param mixed $factoryServiceIds
+     * @param string $factoryServiceId
+     *
+     * @return void
      */
-    public static function addFactoryServiceId($factoryServiceIds)
+    public static function addFactoryServiceId($factoryServiceId)
     {
-        self::$factoryServiceIds[] = $factoryServiceIds;
+        self::$factoryServiceIds[] = $factoryServiceId;
     }
 }

DependencyInjection/Compiler/ProfilerPass.php

@@ -26,6 +26,8 @@ class ProfilerPass implements CompilerPassInterface
 {
     /**
      * {@inheritdoc}
+     *
+     * @return void
      */
     public function process(ContainerBuilder $container)
     {

Doctrine/ORM/GeocoderListener.php

@@ -46,6 +46,7 @@ public function __construct(Provider $geocoder, DriverInterface $driver)
      * {@inheritdoc}
      *
      * @return array
+     * @phpstan-return list<string>
      */
     public function getSubscribedEvents()
     {
@@ -54,6 +55,9 @@ public function getSubscribedEvents()
         ];
     }
 
+    /**
+     * @return void
+     */
     public function onFlush(OnFlushEventArgs $args)
     {
         $em = $args->getEntityManager();
@@ -98,6 +102,8 @@ public function onFlush(OnFlushEventArgs $args)
 
     /**
      * @param object $entity
+     *
+     * @return void
      */
     private function geocodeEntity(ClassMetadata $metadata, $entity)
     {
@@ -107,7 +113,7 @@ private function geocodeEntity(ClassMetadata $metadata, $entity)
             $address = $metadata->addressProperty->getValue($entity);
         }
 
-        if (empty($address)) {
+        if (empty($address) || !is_string($address)) {
             return;
         }
 

Mapping/Driver/AnnotationDriver.php

@@ -23,20 +23,29 @@
  */
 class AnnotationDriver implements DriverInterface
 {
+    /**
+     * @var Reader
+     */
     private $reader;
 
     public function __construct(Reader $reader)
     {
         $this->reader = $reader;
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function isGeocodeable($object): bool
     {
         $reflection = ClassUtils::newReflectionObject($object);
 
         return (bool) $this->reader->getClassAnnotation($reflection, Annotations\Geocodeable::class);
     }
 
+    /**
+     * {@inheritdoc}
+     */
     public function loadMetadataFromObject($object)
     {
         $reflection = ClassUtils::newReflectionObject($object);

Mapping/Driver/AttributeDriver.php

@@ -22,6 +22,9 @@
  */
 final class AttributeDriver implements DriverInterface
 {
+    /**
+     * {@inheritdoc}
+     */
     public function isGeocodeable($object): bool
     {
         if (PHP_VERSION_ID < 80000) {
@@ -34,6 +37,8 @@ public function isGeocodeable($object): bool
     }
 
     /**
+     * {@inheritdoc}
+     *
      * @throws MappingException
      */
     public function loadMetadataFromObject($object): ClassMetadata