class GeocoderProvider in Geocoder 8.2

Defines a geocoder provider plugin annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\geocoder\Annotation\GeocoderPluginBase
    • class \Drupal\geocoder\Annotation\GeocoderProvider

1 file declares its use of GeocoderProvider

ProviderPluginManager.php in src/ProviderPluginManager.php

23 classes are annotated with GeocoderProvider

ArcGisOnline in src/Plugin/Geocoder/Provider/ArcGISOnline.php

Provides an ArcGISOnline geocoder provider plugin.

BingMaps in src/Plugin/Geocoder/Provider/BingMaps.php

Provides a BingMaps geocoder provider plugin.

File in src/Plugin/Geocoder/Provider/File.php

Provides a File geocoder provider plugin.

FreeGeoIp in src/Plugin/Geocoder/Provider/FreeGeoIp.php

Provides a FreeGeoIp geocoder provider plugin.

Geoip in src/Plugin/Geocoder/Provider/Geoip.php

Provides a Geoip geocoder provider plugin.

... See full list

File

src/Annotation/GeocoderProvider.php, line 10

Namespace

Drupal\geocoder\Annotation

class GeocoderProvider extends GeocoderPluginBase {

  /**
   * The plugin handler.
   *
   * This is the fully qualified class name of the plugin handler.
   *
   * @var string
   */
  public $handler = NULL;

  /**
   * Handler arguments names.
   *
   * Plugin annotations can define each item in the array either as key-value
   * pair or as simple array item. When the argument name is in the key, the
   * value will contain the default value to be used if the plugin instance
   * didn't provide a value.
   *
   * @var array
   */
  public $arguments = [];

}

Members

Name	Modifiers	Type	Description	Overrides
GeocoderPluginBase::$id	public	property	The plugin ID.
GeocoderPluginBase::$name	public	property	The human-readable name of the geocoder plugin.
GeocoderProvider::$arguments	public	property	Handler arguments names.
GeocoderProvider::$handler	public	property	The plugin handler.
Plugin::$definition	protected	property	The plugin definition read from the class annotation.	1
Plugin::get	public	function	Gets the value of an annotation. Overrides AnnotationInterface::get	5
Plugin::getClass	public	function	Gets the class of the annotated class. Overrides AnnotationInterface::getClass
Plugin::getId	public	function	Gets the unique ID for this annotated class. Overrides AnnotationInterface::getId
Plugin::getProvider	public	function	Gets the name of the provider of the annotated class. Overrides AnnotationInterface::getProvider
Plugin::parse	protected	function	Parses an annotation into its definition.
Plugin::setClass	public	function	Sets the class of the annotated class. Overrides AnnotationInterface::setClass
Plugin::setProvider	public	function	Sets the name of the provider of the annotated class. Overrides AnnotationInterface::setProvider
Plugin::__construct	public	function	Constructs a Plugin object.	2