class OpenStreetMap in Geocoder 8.3

Provides an OpenStreetMap geocoder provider plugin.

Plugin annotation

@GeocoderProvider(
  id = "openstreetmap",
  name = "OpenStreetMap",
  handler = "\Geocoder\Provider\Nominatim\Nominatim",
  arguments = {
    "rootUrl" = "https://nominatim.openstreetmap.org",
    "userAgent" = "",
    "referer" = ""
  },
  throttle = {
    "period" = 2,
    "limit" = 1
  }
)

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\ProviderUsingHandlerBase
        • class \Drupal\geocoder\ProviderUsingHandlerWithAdapterBase
          • class \Drupal\geocoder\ConfigurableProviderUsingHandlerWithAdapterBase implements ConfigurableInterface, PluginFormInterface uses \Drupal\geocoder\Traits\ConfigurableProviderTrait
            • class \Drupal\geocoder\Plugin\Geocoder\Provider\OpenStreetMap

File

src/Plugin/Geocoder/Provider/OpenStreetMap.php, line 25

Namespace

Drupal\geocoder\Plugin\Geocoder\Provider

class OpenStreetMap extends ConfigurableProviderUsingHandlerWithAdapterBase {

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigurableInterface::defaultConfiguration	public	function	Gets default configuration for this plugin.	11
ConfigurableInterface::getConfiguration	public	function	Gets this plugin's configuration.	12
ConfigurableInterface::setConfiguration	public	function	Sets the configuration for this plugin instance.	12
ConfigurableProviderUsingHandlerWithAdapterBase::$throttle	protected	property	The throttle service.
ConfigurableProviderUsingHandlerWithAdapterBase::$typedConfigManager	protected	property	The typed config manager.
ConfigurableProviderUsingHandlerWithAdapterBase::create	public static	function	Creates an instance of the plugin. Overrides ProviderUsingHandlerWithAdapterBase::create
ConfigurableProviderUsingHandlerWithAdapterBase::doGeocode	protected	function	Performs the geocoding. Overrides ProviderUsingHandlerBase::doGeocode
ConfigurableProviderUsingHandlerWithAdapterBase::doReverse	protected	function	Performs the reverse geocode. Overrides ProviderUsingHandlerBase::doReverse
ConfigurableProviderUsingHandlerWithAdapterBase::__construct	public	function	Constructs a new configurable geocoder provider using handlers. Overrides ProviderUsingHandlerWithAdapterBase::__construct
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.
PluginFormInterface::buildConfigurationForm	public	function	Form constructor.	36
PluginFormInterface::submitConfigurationForm	public	function	Form submission handler.	32
PluginFormInterface::validateConfigurationForm	public	function	Form validation handler.	18
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::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::getArguments	protected	function	Builds a list of arguments to be used by the handler. Overrides ProviderUsingHandlerBase::getArguments
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.