vendor/willdurand/geocoder-bundle/src/ProviderFactory/AbstractFactory.php line 56

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6.  * This file is part of the BazingaGeocoderBundle package.
  7.  * For the full copyright and license information, please view the LICENSE
  8.  * file that was distributed with this source code.
  9.  *
  10.  * @license    MIT License
  11.  */
  13. namespace Bazinga\GeocoderBundle\ProviderFactory;
  15. use Geocoder\Provider\Provider;
  16. use Psr\Http\Client\ClientInterface;
  17. use Symfony\Component\Config\Definition\Exception\InvalidConfigurationException;
  18. use Symfony\Component\OptionsResolver\OptionsResolver;
  20. /**
  21.  * An abstract factory that makes it easier to implement new factories. A class that extend the AbstractFactory
  22.  * should override AbstractFactory::$dependencies and AbstractFactory::configureOptionResolver().
  23.  *
  24.  * @author Tobias Nyholm <tobias.nyholm@gmail.com>
  25.  */
  26. abstract class AbstractFactory implements ProviderFactoryInterface
  27. {
  28.     /**
  29.      * @var list<array{requiredClass: class-string, packageName: string}>
  30.      */
  31.     protected static $dependencies = [];
  33.     protected ?ClientInterface $httpClient;
  35.     public function __construct(?ClientInterface $httpClient = null)
  36.     {
  37.         $this->httpClient = $httpClient;
  38.     }
  40.     /**
  41.      * @param array<mixed, mixed> $config
  42.      */
  43.     abstract protected function getProvider(array $config): Provider;
  45.     /**
  46.      * {@inheritdoc}
  47.      */
  48.     public function createProvider(array $options = []): Provider
  49.     {
  50.         $this->verifyDependencies();
  52.         $resolver = new OptionsResolver();
  53.         static::configureOptionResolver($resolver);
  54.         $config = $resolver->resolve($options);
  56.         return $this->getProvider($config);
  57.     }
  59.     /**
  60.      * {@inheritdoc}
  61.      */
  62.     public static function validate(array $options, $providerName)
  63.     {
  64.         static::verifyDependencies();
  66.         $resolver = new OptionsResolver();
  67.         static::configureOptionResolver($resolver);
  69.         try {
  70.             $resolver->resolve($options);
  71.         } catch (\Exception $e) {
  72.             $message = sprintf(
  73.                 'Error while configure provider "%s". Verify your configuration at "bazinga_geocoder.providers.%s.options". %s',
  74.                 $providerName,
  75.                 $providerName,
  76.                 $e->getMessage()
  77.             );
  79.             throw new InvalidConfigurationException($message, $e->getCode(), $e);
  80.         }
  81.     }
  83.     /**
  84.      * Make sure that we have the required class and throw and exception if we don't.
  85.      *
  86.      * @return void
  87.      *
  88.      * @throws \LogicException
  89.      */
  90.     protected static function verifyDependencies()
  91.     {
  92.         foreach (static::$dependencies as $dependency) {
  93.             if (!class_exists($dependency['requiredClass'])) {
  94.                 throw new \LogicException(sprintf('You must install the "%s" package to use the "%s" factory.', $dependency['packageName'], static::class));
  95.             }
  96.         }
  97.     }
  99.     /**
  100.      * By default, we do not have any options to configure. A factory should override this function and configure
  101.      * the options resolver.
  102.      *
  103.      * @return void
  104.      */
  105.     protected static function configureOptionResolver(OptionsResolver $resolver)
  106.     {
  107.     }
  108. }