You are here

abstract class ProviderUsingHandlerWithAdapterBase in Geocoder 8.3

Same name and namespace in other branches
  1. 8.2 src/ProviderUsingHandlerWithAdapterBase.php \Drupal\geocoder\ProviderUsingHandlerWithAdapterBase

Provides a base class for providers using handlers with HTTP adapter.

Hierarchy

Expanded class hierarchy of ProviderUsingHandlerWithAdapterBase

4 files declare their use of ProviderUsingHandlerWithAdapterBase
GeoPlugin.php in src/Plugin/Geocoder/Provider/GeoPlugin.php
Geopunt.php in src/Plugin/Geocoder/Provider/Geopunt.php
HostIp.php in src/Plugin/Geocoder/Provider/HostIp.php
Spw.php in src/Plugin/Geocoder/Provider/Spw.php

File

src/ProviderUsingHandlerWithAdapterBase.php, line 14

Namespace

Drupal\geocoder
View source
abstract class ProviderUsingHandlerWithAdapterBase extends ProviderUsingHandlerBase {

  /**
   * The HTTP adapter.
   *
   * @var \Http\Client\HttpClient
   */
  protected $httpAdapter;

  /**
   * Constructs a geocoder provider plugin object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory service.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
   *   The cache backend used to cache geocoding data.
   * @param \Drupal\Core\Language\LanguageManagerInterface $language_manager
   *   The Drupal language manager service.
   * @param \Http\Client\HttpClient $http_adapter
   *   The HTTP adapter.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, ConfigFactoryInterface $config_factory, CacheBackendInterface $cache_backend, LanguageManagerInterface $language_manager, HttpClient $http_adapter) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $config_factory, $cache_backend, $language_manager);
    $this->httpAdapter = $http_adapter;
  }

  /**
   * {@inheritdoc}
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('config.factory'), $container
      ->get('cache.geocoder'), $container
      ->get('language_manager'), $container
      ->get('geocoder.http_adapter'));
  }

  /**
   * {@inheritdoc}
   */
  protected function getArguments() : array {
    return array_merge([
      $this->httpAdapter,
    ], parent::getArguments());
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
ProviderBase::$cacheBackend protected property The cache backend used to cache geocoding data.
ProviderBase::$configFactory protected property The config factory service.
ProviderBase::$languageManager protected property The configurable language manager.
ProviderBase::geocode public function Geocode a source string. Overrides ProviderInterface::geocode
ProviderBase::getCacheId protected function Builds a cached id.
ProviderBase::process protected function Provides a helper callback for geocode() and reverse().
ProviderBase::reverse public function Reverse geocode latitude and longitude. Overrides ProviderInterface::reverse
ProviderUsingHandlerBase::$handler protected property The provider handler.
ProviderUsingHandlerBase::$handlerWrapper protected property The V4 Stateful handler wrapper.
ProviderUsingHandlerBase::doGeocode protected function Overrides ProviderBase::doGeocode 1
ProviderUsingHandlerBase::doReverse protected function Overrides ProviderBase::doReverse 1
ProviderUsingHandlerBase::getHandler protected function Returns the provider handler. 1
ProviderUsingHandlerBase::getHandlerWrapper protected function Returns the V4 Stateful wrapper.
ProviderUsingHandlerWithAdapterBase::$httpAdapter protected property The HTTP adapter.
ProviderUsingHandlerWithAdapterBase::create public static function Overrides ProviderBase::create 1
ProviderUsingHandlerWithAdapterBase::getArguments protected function Builds a list of arguments to be used by the handler. Overrides ProviderUsingHandlerBase::getArguments
ProviderUsingHandlerWithAdapterBase::__construct public function Constructs a geocoder provider plugin object. Overrides ProviderUsingHandlerBase::__construct 1
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.