class DataProvider in Geolocation Field 8.2

Defines a DataProvider annotation object.

Hierarchy

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

See also

\Drupal\geolocation\DataProviderManager

Plugin API

4 classes are annotated with DataProvider

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

Provides default address field.

Geofield in modules/geolocation_geofield/src/Plugin/geolocation/DataProvider/Geofield.php

Provides Google Maps.

GeolocationFieldProvider in src/Plugin/geolocation/DataProvider/GeolocationFieldProvider.php

Provides default geolocation field.

SearchAPI in modules/geolocation_search_api/src/Plugin/geolocation/DataProvider/SearchAPI.php

Provides Google Maps.

File

src/Annotation/DataProvider.php, line 15

Namespace

Drupal\geolocation\Annotation

class DataProvider extends Plugin {

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

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

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

}

Members

Name	Modifiers	Type	Description	Overrides
DataProvider::$description	public	property	The description of the DataProvider.
DataProvider::$id	public	property	The plugin ID.
DataProvider::$name	public	property	The name of the DataProvider.
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