class GeocodeOriginAutocomplete in Geocoder 8.2

Defines 'Geocode Origin, with Autocomplete' proximity source plugin.

Plugin annotation

@GeofieldProximitySource(
  id = "geofield_geocode_origin_autocomplete",
  label = @Translation("Geocode Origin, with Autocomplete"),
  description = @Translation("Geocodes origin from free text input, with autocomplete."),
  exposedDescription = @Translation("Geocode origin from free text input, with autocomplete."),
  exposedOnly = true,
  context = {},
  no_ui = true
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\geofield\Plugin\GeofieldProximitySourceBase implements GeofieldProximitySourceInterface uses StringTranslationTrait
    • class \Drupal\geocoder\Plugin\GeofieldProximitySource\GeocodeOrigin implements ContainerFactoryPluginInterface
      • class \Drupal\geocoder\Plugin\GeofieldProximitySource\deprecated\GeocodeOriginAutocomplete

File

src/Plugin/GeofieldProximitySource/deprecated/GeocodeOriginAutocomplete.php, line 24

Namespace

Drupal\geocoder\Plugin\GeofieldProximitySource\deprecated

class GeocodeOriginAutocomplete extends GeocodeOrigin {

  /**
   * Constructs a GeocodeOrigin object.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\geocoder\Geocoder $geocoder
   *   The Geocoder Service.
   * @param \Drupal\geocoder\ProviderPluginManager $providerPluginManager
   *   The Providers Plugin Manager.
   * @param \Drupal\geocoder\FormatterPluginManager $formatterPluginManager
   *   The Providers Plugin Manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, Geocoder $geocoder, ProviderPluginManager $providerPluginManager, FormatterPluginManager $formatterPluginManager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $geocoder, $providerPluginManager, $formatterPluginManager);
    $this->useAutocomplete = isset($configuration['use_autocomplete']) ? $configuration['use_autocomplete'] : 1;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('geocoder'), $container
      ->get('plugin.manager.geocoder.provider'), $container
      ->get('plugin.manager.geocoder.formatter'));
  }

}

Members

Name	Modifiers	Type	Description	Overrides
GeocodeOrigin::$addressFormat	protected	property	The Address Format for autocomplete suggestions.
GeocodeOrigin::$delay	protected	property	The delay for starting the Geocoder search.
GeocodeOrigin::$formatterPluginManager	protected	property	The Formatter Plugin Manager.
GeocodeOrigin::$geocoder	protected	property	The Geocoder Service.
GeocodeOrigin::$incompatiblePlugins	protected	property	Geocoder Plugins not compatible with Geofield Proximity Geocoding.
GeocodeOrigin::$minTerms	protected	property	The (minimum) number of terms for the Geocoder to start processing.
GeocodeOrigin::$options	protected	property	Geocoder Control Specific Options.
GeocodeOrigin::$originAddress	protected	property	The origin address to geocode and measure proximity from.
GeocodeOrigin::$providerPluginManager	protected	property	The Providers Plugin Manager.
GeocodeOrigin::$useAutocomplete	protected	property	The flag for Address search autocomplete option.
GeocodeOrigin::buildOptionsForm	public	function	Builds the specific form elements for the geofield proximity plugin. Overrides GeofieldProximitySourceBase::buildOptionsForm
GeocodeOrigin::getAddressOrigin	protected	function	Geocode the Origin Address.
GeocodeOrigin::getEnabledProviderPlugins	public	function	Get the list of enabled Provider plugins.
GeocodeOrigin::jsonValidate	public static	function	Form element json format validation handler.
GeocodeOrigin::validateOptionsForm	public	function	Validates the options form for the geofield proximity plugin. Overrides GeofieldProximitySourceBase::validateOptionsForm
GeocodeOrigin::validatePluginsSettingsForm	public static	function
GeocodeOriginAutocomplete::create	public static	function	Creates an instance of the plugin. Overrides GeocodeOrigin::create
GeocodeOriginAutocomplete::__construct	public	function	Constructs a GeocodeOrigin object. Overrides GeocodeOrigin::__construct
GeofieldProximitySourceBase::$origin	protected	property	The origin point to measure proximity from.
GeofieldProximitySourceBase::$units	protected	property	The name of the constant defining the measurement unit.
GeofieldProximitySourceBase::$viewHandler	protected	property	The view handler which uses this proximity plugin.
GeofieldProximitySourceBase::getHaversineOptions	public	function	Gets the haversine options. Overrides GeofieldProximitySourceInterface::getHaversineOptions
GeofieldProximitySourceBase::getOrigin	public	function	Gets the proximity distance origin. Overrides GeofieldProximitySourceInterface::getOrigin	2
GeofieldProximitySourceBase::getProximity	public	function	Get the calculated proximity. Overrides GeofieldProximitySourceInterface::getProximity
GeofieldProximitySourceBase::getUnits	public	function	Get the current units. Overrides GeofieldProximitySourceInterface::getUnits
GeofieldProximitySourceBase::getUnitsOptions	public	function	Get the list of valid options for units.
GeofieldProximitySourceBase::isEmptyLocation	public	function	Check if Location is empty. Overrides GeofieldProximitySourceInterface::isEmptyLocation
GeofieldProximitySourceBase::isValidLocation	public	function	Check for a valid couple of latitude and longitude. Overrides GeofieldProximitySourceInterface::isValidLocation
GeofieldProximitySourceBase::setOrigin	public	function	Sets the proximity distance origin. Overrides GeofieldProximitySourceInterface::setOrigin
GeofieldProximitySourceBase::setUnits	public	function	Set the units to perform the calculation in. Overrides GeofieldProximitySourceInterface::setUnits
GeofieldProximitySourceBase::setViewHandler	public	function	Sets view handler which uses this proximity plugin. Overrides GeofieldProximitySourceInterface::setViewHandler
PluginBase::$configuration	protected	property	Configuration information passed into the plugin.	1
PluginBase::$pluginDefinition	protected	property	The plugin implementation definition.	1
PluginBase::$pluginId	protected	property	The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR		constant	A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId	public	function	Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId	public	function	Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition	public	function	Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition	3
PluginBase::getPluginId	public	function	Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable	public	function	Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	1
StringTranslationTrait::formatPlural	protected	function	Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals	protected	function	Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation	protected	function	Gets the string translation service.
StringTranslationTrait::setStringTranslation	public	function	Sets the string translation service to use.	2
StringTranslationTrait::t	protected	function	Translates a string to the current language or to a given language.