GeocoderProvider.php in Geocoder 8.3

Namespace

Drupal\geocoder\Annotation

File

src/Annotation/GeocoderProvider.php

<?php

namespace Drupal\geocoder\Annotation;


/**
 * Defines a geocoder provider plugin annotation object.
 *
 * @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 = [];

  /**
   * Throttle.
   *
   * Associative array where "period" is in seconds and "limit" is the maximum
   * number of requests allowed during the period.
   * This property is optional in the annotation and can be left out.
   *
   * @var array
   */
  public $throttle = NULL;

}

Classes

Name	Description
GeocoderProvider	Defines a geocoder provider plugin annotation object.