class GeofieldProximitySource in Geofield 8

Defines a Geofield Proximity Source annotation object.

Hierarchy

• class \Drupal\Component\Annotation\Plugin implements AnnotationInterface
  • class \Drupal\geofield\Annotation\GeofieldProximitySource

See also

\Drupal\geofield\Plugin\GeofieldProximitySourceManager

Plugin API

4 classes are annotated with GeofieldProximitySource

ClientLocationOriginFilter in src/Plugin/GeofieldProximitySource/ClientLocationOriginFilter.php

Defines 'Geofield Client Location Origin' plugin.

ContextProximityFilter in src/Plugin/GeofieldProximitySource/ContextProximityFilter.php

Defines 'Geofield Context Filter' plugin.

ManualOriginDefault in src/Plugin/GeofieldProximitySource/ManualOriginDefault.php

Defines 'Geofield Manual Origin' plugin.

OriginFromProximityFilter in src/Plugin/GeofieldProximitySource/OriginFromProximityFilter.php

Defines 'Geofield Custom Origin' plugin.

File

src/Annotation/GeofieldProximitySource.php, line 15

Namespace

Drupal\geofield\Annotation

class GeofieldProximitySource extends Plugin {

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

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

  /**
   * A short description of the plugin.
   *
   * @var \Drupal\Core\Annotation\Translation
   *
   * @ingroup plugin_translatable
   */
  public $description;

  /**
   * A description to show in the exposed form.
   *
   * @var \Drupal\Core\Annotation\Translation
   *   (optional)
   *
   * @ingroup plugin_translatable
   */
  public $exposedDescription;

  /**
   * An array of the view handler plugins type (contexts) it would work for.
   *
   * Possible values:
   *   - filter
   *   - sort
   *   - field
   *   - NULL (all)
   *
   * @var array
   *   (optional)
   *
   * @ingroup plugin_translatable
   */
  public $context;

  /**
   * A flag that specify if the plugin should work only if exposed filter.
   *
   * @var bool
   *   (optional)
   *
   * @ingroup plugin_translatable
   */
  public $exposedOnly;

}

Members

Name	Modifiers	Type	Description	Overrides
GeofieldProximitySource::$context	public	property	An array of the view handler plugins type (contexts) it would work for.
GeofieldProximitySource::$description	public	property	A short description of the plugin.
GeofieldProximitySource::$exposedDescription	public	property	A description to show in the exposed form.
GeofieldProximitySource::$exposedOnly	public	property	A flag that specify if the plugin should work only if exposed filter.
GeofieldProximitySource::$id	public	property	The plugin ID.
GeofieldProximitySource::$label	public	property	The label of the 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