class LocationInput in Search API Location 8

Defines a Location Input annotation.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\search_api_location\Annotation\LocationInput

See also

\Drupal\search_api_location\LocationInput\LocationInputPluginManager

Plugin API

3 classes are annotated with LocationInput

Geocode in modules/search_api_location_geocoder/src/Plugin/search_api_location/location_input/Geocode.php

Represents the Raw Location Input.

Map in src/Plugin/search_api_location/location_input/Map.php

Represents the Raw Location Input.

Raw in src/Plugin/search_api_location/location_input/Raw.php

Represents the Raw Location Input.

File

src/Annotation/LocationInput.php, line 17

Namespace

Drupal\search_api_location\Annotation

class LocationInput extends Plugin {

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

  /**
   * The human-readable name of the Location Input plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $label;

  /**
   * The Location Input description.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description;

}

Members

Name	Modifiers	Type	Description	Overrides
LocationInput::$description	public	property	The Location Input description.
LocationInput::$id	public	property	The Location Input plugin id.
LocationInput::$label	public	property	The human-readable name of the Location Input plugin.
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