class TestProvider in Geocoder 8.2

Provides a geocoding provider for testing purposes.

Plugin annotation

@GeocoderProvider(
 id = "test_provider",
 name = "Test provider"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\geocoder\ProviderBase implements ContainerFactoryPluginInterface, ProviderInterface
      • class \Drupal\geocoder_geofield_test\Plugin\Geocoder\Provider\TestProvider

File

modules/geocoder_geofield/tests/modules/geocoder_geofield_test/src/Plugin/Geocoder/Provider/TestProvider.php, line 16

Namespace

Drupal\geocoder_geofield_test\Plugin\Geocoder\Provider

class TestProvider extends ProviderBase {

  /**
   * The address factory.
   *
   * @var \Geocoder\Model\AddressFactory
   */
  protected $addressFactory;

  /**
   * {@inheritdoc}
   */
  protected function doGeocode($source) {
    switch ($source) {
      case 'Gotham City':
        return $this
          ->getAddressFactory()
          ->createFromArray([
          [
            'latitude' => 20,
            'longitude' => 40,
          ],
        ]);
      default:
        return FALSE;
    }
  }

  /**
   * {@inheritdoc}
   */
  public function doReverse($latitude, $longitude) {
    return FALSE;
  }

  /**
   * Returns the address factory.
   *
   * @return \Geocoder\Model\AddressFactory
   *   Returns Address factory.
   */
  protected function getAddressFactory() {
    if (!isset($this->addressFactory)) {
      $this->addressFactory = new AddressFactory();
    }
    return $this->addressFactory;
  }

}

Members

Name	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::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	1
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
ProviderBase::__construct	public	function	Constructs a geocoder provider plugin object. Overrides PluginBase::__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.
TestProvider::$addressFactory	protected	property	The address factory.
TestProvider::doGeocode	protected	function	Performs the geocoding. Overrides ProviderBase::doGeocode
TestProvider::doReverse	public	function	Performs the reverse geocode. Overrides ProviderBase::doReverse
TestProvider::getAddressFactory	protected	function	Returns the address factory.