Add types declarations

geocoder-php · Jan 26, 2024 · 162cb1e · 162cb1e
1 parent 06c094c
commit 162cb1e
Show file tree

Hide file tree

Showing 54 changed files with 94 additions and 189 deletions.
diff --git a/src/BazingaGeocoderBundle.php b/src/BazingaGeocoderBundle.php
@@ -23,10 +23,7 @@
  */
 class BazingaGeocoderBundle extends Bundle
 {
-    /**
-     * @return void
-     */
-    public function build(ContainerBuilder $container)
+    public function build(ContainerBuilder $container): void
     {
         parent::build($container);
 

diff --git a/src/Command/GeocodeCommand.php b/src/Command/GeocodeCommand.php
@@ -34,10 +34,7 @@ public function __construct(ProviderAggregator $geocoder)
         parent::__construct();
     }
 
-    /**
-     * @return void
-     */
-    protected function configure()
+    protected function configure(): void
     {
         $this
             ->setName('geocoder:geocode')

diff --git a/src/DataCollector/GeocoderDataCollector.php b/src/DataCollector/GeocoderDataCollector.php
@@ -34,20 +34,14 @@ public function __construct()
         $this->data['providers'] = [];
     }
 
-    /**
-     * @return void
-     */
-    public function reset()
+    public function reset(): void
     {
         $this->instances = [];
         $this->data['queries'] = [];
         $this->data['providers'] = [];
     }
 
-    /**
-     * @return void
-     */
-    public function collect(Request $request, Response $response, \Throwable $exception = null)
+    public function collect(Request $request, Response $response, \Throwable $exception = null): void
     {
         if (!empty($this->data['queries'])) {
             // To avoid collection more that once.
@@ -101,15 +95,10 @@ public function getProviders(): array
      */
     public function getProviderQueries(string $provider): array
     {
-        return array_filter($this->data['queries'], static function ($data) use ($provider) {
-            return $data['providerName'] === $provider;
-        });
+        return array_filter($this->data['queries'], static fn (array $data): bool => $data['providerName'] === $provider);
     }
 
-    /**
-     * @return void
-     */
-    public function addInstance(ProfilingPlugin $instance)
+    public function addInstance(ProfilingPlugin $instance): void
     {
         $this->instances[] = $instance;
         $this->data['providers'][] = $instance->getName();

diff --git a/src/DependencyInjection/BazingaGeocoderExtension.php b/src/DependencyInjection/BazingaGeocoderExtension.php
@@ -41,10 +41,8 @@ class BazingaGeocoderExtension extends Extension
 {
     /**
      * @param array<mixed, mixed> $configs
-     *
-     * @return void
      */
-    public function load(array $configs, ContainerBuilder $container)
+    public function load(array $configs, ContainerBuilder $container): void
     {
         $processor = new Processor();
         $configuration = $this->getConfiguration($configs, $container);
@@ -78,10 +76,8 @@ public function load(array $configs, ContainerBuilder $container)
 
     /**
      * @param array<mixed, mixed> $config
-     *
-     * @return void
      */
-    private function loadProviders(ContainerBuilder $container, array $config)
+    private function loadProviders(ContainerBuilder $container, array $config): void
     {
         foreach ($config['providers'] as $providerName => $providerConfig) {
             try {
@@ -181,7 +177,7 @@ public function configureProviderPlugins(ContainerBuilder $container, array $con
                 ->addTag('bazinga_geocoder.profiling_plugin');
         }
 
-        return array_map(static fn (string $id) => new Reference($id), $plugins);
+        return array_map(static fn (string $id): Reference => new Reference($id), $plugins);
     }
 
     /**

diff --git a/src/DependencyInjection/Compiler/AddProvidersPass.php b/src/DependencyInjection/Compiler/AddProvidersPass.php
@@ -25,10 +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)
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->hasDefinition(ProviderAggregator::class)) {
             return;

diff --git a/src/DependencyInjection/Compiler/FactoryValidatorPass.php b/src/DependencyInjection/Compiler/FactoryValidatorPass.php
@@ -26,12 +26,9 @@ class FactoryValidatorPass implements CompilerPassInterface
     /**
      * @var string[]
      */
-    private static $factoryServiceIds = [];
+    private static array $factoryServiceIds = [];
 
-    /**
-     * @return void
-     */
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         foreach (self::$factoryServiceIds as $id) {
             if (!$container->hasAlias($id) && !$container->hasDefinition($id)) {
@@ -40,12 +37,7 @@ public function process(ContainerBuilder $container)
         }
     }
 
-    /**
-     * @param string $factoryServiceId
-     *
-     * @return void
-     */
-    public static function addFactoryServiceId($factoryServiceId)
+    public static function addFactoryServiceId(string $factoryServiceId): void
     {
         self::$factoryServiceIds[] = $factoryServiceId;
     }

diff --git a/src/DependencyInjection/Compiler/ProfilerPass.php b/src/DependencyInjection/Compiler/ProfilerPass.php
@@ -24,10 +24,7 @@
  */
 class ProfilerPass implements CompilerPassInterface
 {
-    /**
-     * @return void
-     */
-    public function process(ContainerBuilder $container)
+    public function process(ContainerBuilder $container): void
     {
         if (!$container->hasDefinition(GeocoderDataCollector::class)) {
             return;

diff --git a/src/DependencyInjection/Configuration.php b/src/DependencyInjection/Configuration.php
@@ -56,9 +56,7 @@ public function getConfigTreeBuilder(): TreeBuilder
             ->arrayNode('fake_ip')
                 ->beforeNormalization()
                 ->ifString()
-                    ->then(function ($value) {
-                        return ['ip' => $value];
-                    })
+                    ->then(static fn (string $value): array => ['ip' => $value])
                 ->end()
                 ->canBeEnabled()
                 ->children()
@@ -73,10 +71,7 @@ public function getConfigTreeBuilder(): TreeBuilder
         return $treeBuilder;
     }
 
-    /**
-     * @return ArrayNodeDefinition
-     */
-    private function getProvidersNode()
+    private function getProvidersNode(): ArrayNodeDefinition
     {
         $treeBuilder = new TreeBuilder('providers');
         $rootNode = $treeBuilder->getRootNode();
@@ -111,10 +106,8 @@ private function getProvidersNode()
 
     /**
      * Create plugin node of a client.
-     *
-     * @return ArrayNodeDefinition The plugin node
      */
-    private function createClientPluginNode()
+    private function createClientPluginNode(): ArrayNodeDefinition
     {
         $treeBuilder = new TreeBuilder('plugins');
         $rootNode = $treeBuilder->getRootNode();

diff --git a/src/Doctrine/ORM/GeocoderListener.php b/src/Doctrine/ORM/GeocoderListener.php
@@ -45,10 +45,7 @@ public function getSubscribedEvents(): array
         ];
     }
 
-    /**
-     * @return void
-     */
-    public function onFlush(OnFlushEventArgs $args)
+    public function onFlush(OnFlushEventArgs $args): void
     {
         $em = method_exists($args, 'getObjectManager') ? $args->getObjectManager() : $args->getEntityManager();
         $uow = $em->getUnitOfWork();
@@ -92,10 +89,8 @@ public function onFlush(OnFlushEventArgs $args)
 
     /**
      * @param object $entity
-     *
-     * @return void
      */
-    private function geocodeEntity(ClassMetadata $metadata, $entity)
+    private function geocodeEntity(ClassMetadata $metadata, $entity): void
     {
         if (null !== $metadata->addressGetter) {
             $address = $metadata->addressGetter->invoke($entity);

diff --git a/src/Mapping/ClassMetadata.php b/src/Mapping/ClassMetadata.php
@@ -17,23 +17,11 @@
  */
 class ClassMetadata
 {
-    /**
-     * @var \ReflectionProperty
-     */
-    public $addressProperty;
+    public \ReflectionProperty $addressProperty;
 
-    /**
-     * @var \ReflectionProperty
-     */
-    public $latitudeProperty;
+    public \ReflectionProperty $latitudeProperty;
 
-    /**
-     * @var \ReflectionProperty
-     */
-    public $longitudeProperty;
+    public \ReflectionProperty $longitudeProperty;
 
-    /**
-     * @var \ReflectionMethod
-     */
-    public $addressGetter;
+    public ?\ReflectionMethod $addressGetter = null;
 }
diff --git a/src/Mapping/Driver/AnnotationDriver.php b/src/Mapping/Driver/AnnotationDriver.php
@@ -37,7 +37,7 @@ public function isGeocodeable($object): bool
         return (bool) $this->reader->getClassAnnotation($reflection, Annotations\Geocodeable::class);
     }
 
-    public function loadMetadataFromObject($object)
+    public function loadMetadataFromObject($object): ClassMetadata
     {
         $reflection = ClassUtils::newReflectionObject($object);
 

diff --git a/src/Mapping/Driver/DriverInterface.php b/src/Mapping/Driver/DriverInterface.php
@@ -23,8 +23,6 @@ public function isGeocodeable($object): bool;
 
     /**
      * @param object $object
-     *
-     * @return ClassMetadata
      */
-    public function loadMetadataFromObject($object);
+    public function loadMetadataFromObject($object): ClassMetadata;
 }
diff --git a/src/Plugin/FakeIpPlugin.php b/src/Plugin/FakeIpPlugin.php
@@ -41,10 +41,7 @@ public function __construct(?string $needle, string $replacement = null, bool $u
         }
     }
 
-    /**
-     * @return Promise
-     */
-    public function handleQuery(Query $query, callable $next, callable $first)
+    public function handleQuery(Query $query, callable $next, callable $first): Promise
     {
         if (!$query instanceof GeocodeQuery) {
             return $next($query);

diff --git a/src/Plugin/ProfilingPlugin.php b/src/Plugin/ProfilingPlugin.php
@@ -29,31 +29,28 @@ class ProfilingPlugin implements Plugin
     /**
      * @var list<array{query: Query, queryString: string, duration: float, providerName: string, result: mixed, resultCount: int}>
      */
-    private $queries = [];
+    private array $queries = [];
 
     /**
-     * @var string service id of the provider
+     * service id of the provider.
      */
-    private $name;
+    private string $name;
 
     public function __construct(string $name)
     {
         $this->name = $name;
     }
 
-    /**
-     * @return Promise
-     */
-    public function handleQuery(Query $query, callable $next, callable $first)
+    public function handleQuery(Query $query, callable $next, callable $first): Promise
     {
         $startTime = microtime(true);
 
-        return $next($query)->then(function (Collection $result) use ($query, $startTime) {
+        return $next($query)->then(function (Collection $result) use ($query, $startTime): Collection {
             $duration = (microtime(true) - $startTime) * 1000;
             $this->logQuery($query, $duration, $result);
 
             return $result;
-        }, function (Exception $exception) use ($query, $startTime) {
+        }, function (Exception $exception) use ($query, $startTime): void {
             $duration = (microtime(true) - $startTime) * 1000;
             $this->logQuery($query, $duration, $exception);
 
@@ -63,10 +60,8 @@ public function handleQuery(Query $query, callable $next, callable $first)
 
     /**
      * @param mixed $result
-     *
-     * @return void
      */
-    private function logQuery(Query $query, float $duration, $result = null)
+    private function logQuery(Query $query, float $duration, $result = null): void
     {
         if ($query instanceof GeocodeQuery) {
             $queryString = $query->getText();

diff --git a/src/ProviderFactory/AbstractFactory.php b/src/ProviderFactory/AbstractFactory.php
@@ -53,7 +53,7 @@ public function createProvider(array $options = []): Provider
         return $this->getProvider($config);
     }
 
-    public static function validate(array $options, $providerName)
+    public static function validate(array $options, $providerName): void
     {
         static::verifyDependencies();
 

diff --git a/src/ProviderFactory/AlgoliaFactory.php b/src/ProviderFactory/AlgoliaFactory.php
@@ -34,7 +34,7 @@ protected function getProvider(array $config): Provider
         return new AlgoliaPlaces($httpClient, $config['api_key'], $config['app_id']);
     }
 
-    protected static function configureOptionResolver(OptionsResolver $resolver)
+    protected static function configureOptionResolver(OptionsResolver $resolver): void
     {
         $resolver->setDefaults([
             'httplug_client' => null,

diff --git a/src/ProviderFactory/ArcGISOnlineFactory.php b/src/ProviderFactory/ArcGISOnlineFactory.php
@@ -34,7 +34,7 @@ protected function getProvider(array $config): Provider
         return new ArcGISOnline($httpClient, $config['source_country']);
     }
 
-    protected static function configureOptionResolver(OptionsResolver $resolver)
+    protected static function configureOptionResolver(OptionsResolver $resolver): void
     {
         $resolver->setDefaults([
             'httplug_client' => null,

diff --git a/src/ProviderFactory/BingMapsFactory.php b/src/ProviderFactory/BingMapsFactory.php
@@ -34,7 +34,7 @@ protected function getProvider(array $config): Provider
         return new BingMaps($httpClient, $config['api_key']);
     }
 
-    protected static function configureOptionResolver(OptionsResolver $resolver)
+    protected static function configureOptionResolver(OptionsResolver $resolver): void
     {
         $resolver->setDefaults([
             'httplug_client' => null,

diff --git a/src/ProviderFactory/ChainFactory.php b/src/ProviderFactory/ChainFactory.php
@@ -42,7 +42,7 @@ protected function getProvider(array $config): Provider
         return $provider;
     }
 
-    protected static function configureOptionResolver(OptionsResolver $resolver)
+    protected static function configureOptionResolver(OptionsResolver $resolver): void
     {
         parent::configureOptionResolver($resolver);
 

diff --git a/src/ProviderFactory/FreeGeoIpFactory.php b/src/ProviderFactory/FreeGeoIpFactory.php
@@ -34,7 +34,7 @@ protected function getProvider(array $config): Provider
         return new FreeGeoIp($httpClient, $config['base_url']);
     }
 
-    protected static function configureOptionResolver(OptionsResolver $resolver)
+    protected static function configureOptionResolver(OptionsResolver $resolver): void
     {
         $resolver->setDefaults([
             'httplug_client' => null,

diff --git a/src/ProviderFactory/GeoIP2Factory.php b/src/ProviderFactory/GeoIP2Factory.php
@@ -47,7 +47,7 @@ protected function getProvider(array $config): Provider
         return new GeoIP2($adapter);
     }
 
-    protected static function configureOptionResolver(OptionsResolver $resolver)
+    protected static function configureOptionResolver(OptionsResolver $resolver): void
     {
         $resolver->setDefaults([
             'model' => GeoIP2Adapter::GEOIP2_MODEL_CITY,

diff --git a/src/ProviderFactory/GeoIPsFactory.php b/src/ProviderFactory/GeoIPsFactory.php
@@ -40,7 +40,7 @@ protected function getProvider(array $config): Provider
         return new GeoIPs($httplug, $config['api_key']);
     }
 
-    protected static function configureOptionResolver(OptionsResolver $resolver)
+    protected static function configureOptionResolver(OptionsResolver $resolver): void
     {
         $resolver->setDefaults([
             'httplug_client' => null,

diff --git a/src/ProviderFactory/GeoPluginFactory.php b/src/ProviderFactory/GeoPluginFactory.php
@@ -34,7 +34,7 @@ protected function getProvider(array $config): Provider
         return new GeoPlugin($httpClient);
     }
 
-    protected static function configureOptionResolver(OptionsResolver $resolver)
+    protected static function configureOptionResolver(OptionsResolver $resolver): void
     {
         $resolver->setDefaults([
             'httplug_client' => null,