class Geocoder in Geolocation Field 8.3

Defines a geocoder annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\geolocation\Annotation\Geocoder

See also

\Drupal\geolocation\GeocoderManager

Plugin API

4 string references to 'Geocoder'

AddressFieldProvider::getSettingsForm in modules/geolocation_address/src/Plugin/geolocation/DataProvider/AddressFieldProvider.php

Provide data provider settings form array.

geolocation.location_input.schema.yml in config/schema/geolocation.location_input.schema.yml

config/schema/geolocation.location_input.schema.yml

geolocation_google_maps.map_features.schema.yml in modules/geolocation_google_maps/config/schema/geolocation_google_maps.map_features.schema.yml

modules/geolocation_google_maps/config/schema/geolocation_google_maps.map_features.schema.yml

geolocation_leaflet.map_features.schema.yml in modules/geolocation_leaflet/config/schema/geolocation_leaflet.map_features.schema.yml

modules/geolocation_leaflet/config/schema/geolocation_leaflet.map_features.schema.yml

7 classes are annotated with Geocoder

Dummy in tests/modules/geolocation_dummy_geocoder/src/Plugin/geolocation/Geocoder/Dummy.php

Provides the Google Geocoding API.

Geocodio in modules/geolocation_geocodio/src/Plugin/geolocation/Geocoder/Geocodio.php

Provides a Geocodio integration.

GoogleGeocodingAPI in modules/geolocation_google_maps/src/Plugin/geolocation/Geocoder/GoogleGeocodingAPI.php

Provides the Google Geocoding API.

GooglePlacesAPI in modules/geolocation_google_maps/modules/geolocation_google_places_api/src/Plugin/geolocation/Geocoder/GooglePlacesAPI.php

Provides the Google Places API.

Nominatim in modules/geolocation_leaflet/src/Plugin/geolocation/Geocoder/Nominatim.php

Provides the Nominatim API.

... See full list

File

src/Annotation/Geocoder.php, line 15

Namespace

Drupal\geolocation\Annotation

class Geocoder extends Plugin {

  /**
   * The plugin ID.
   *
   * @var string
   */
  public $id;

  /**
   * The name of the geocoder.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $name;

  /**
   * The description of the geocoder.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description;

  /**
   * Can the geocoder retrieve coordinates.
   *
   * @var bool
   */
  public $locationCapable;

  /**
   * Can the geocoder retrieve boundaries.
   *
   * @var bool
   */
  public $boundaryCapable;

  /**
   * Can the geocoder be used in the frontend.
   *
   * @var bool
   */
  public $frontendCapable;

  /**
   * Can the geocoder perform reverse geocoding.
   *
   * @var bool
   */
  public $reverseCapable;

}

Members

Name	Modifiers	Type	Description	Overrides
Geocoder::$boundaryCapable	public	property	Can the geocoder retrieve boundaries.
Geocoder::$description	public	property	The description of the geocoder.
Geocoder::$frontendCapable	public	property	Can the geocoder be used in the frontend.
Geocoder::$id	public	property	The plugin ID.
Geocoder::$locationCapable	public	property	Can the geocoder retrieve coordinates.
Geocoder::$name	public	property	The name of the geocoder.
Geocoder::$reverseCapable	public	property	Can the geocoder perform reverse geocoding.
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