ProviderUsingHandlerBase.php in Geocoder 8.2

Namespace

Drupal\geocoder

File

src/ProviderUsingHandlerBase.php

<?php

namespace Drupal\geocoder;

use Drupal\Core\Cache\CacheBackendInterface;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException;

/**
 * Provides a base class for providers using handlers.
 */
abstract class ProviderUsingHandlerBase extends ProviderBase {

  /**
   * The provider handler.
   *
   * @var \Geocoder\Provider\Provider
   */
  protected $handler;

  /**
   * {@inheritdoc}
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ConfigFactoryInterface $config_factory, CacheBackendInterface $cache_backend) {

    // The ProviderBase constructor needs to be run anyway (before possible
    // exception @throw), to allow the ProviderBase process method.
    parent::__construct($configuration, $plugin_id, $plugin_definition, $config_factory, $cache_backend);
    if (empty($plugin_definition['handler'])) {
      throw new InvalidPluginDefinitionException($plugin_id, "Plugin '{$plugin_id}' should define an handler.");
    }
  }

  /**
   * {@inheritdoc}
   *
   * @throws \ReflectionException
   */
  protected function doGeocode($source) {
    return $this
      ->getHandler()
      ->geocode($source);
  }

  /**
   * {@inheritdoc}
   *
   * @throws \ReflectionException
   */
  protected function doReverse($latitude, $longitude) {
    return $this
      ->getHandler()
      ->reverse($latitude, $longitude);
  }

  /**
   * Returns the provider handler.
   *
   * @return \Geocoder\Provider\Provider
   *   The provider plugin.
   *
   * @throws \ReflectionException
   */
  protected function getHandler() {
    if (!isset($this->handler)) {
      $definition = $this
        ->getPluginDefinition();
      $reflection_class = new \ReflectionClass($definition['handler']);
      $this->handler = $reflection_class
        ->newInstanceArgs($this
        ->getArguments());
    }
    return $this->handler;
  }

  /**
   * Builds a list of arguments to be used by the handler.
   *
   * @return array
   *   The list of arguments for handler instantiation.
   */
  protected function getArguments() {
    $arguments = [];
    foreach ($this
      ->getPluginDefinition()['arguments'] as $key => $argument) {

      // No default value has been passed.
      if (is_string($key)) {
        $config_name = $key;
        $default_value = $argument;
      }
      else {
        $config_name = $argument;
        $default_value = NULL;
      }
      $arguments[] = isset($this->configuration[$config_name]) ? $this->configuration[$config_name] : $default_value;
    }
    return $arguments;
  }

}

Classes

Name	Description
ProviderUsingHandlerBase	Provides a base class for providers using handlers.