abstract class LocationInputBase in Geolocation Field 8.3

Class LocationInputBase.

@package Drupal\geolocation

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\geolocation\LocationInputBase implements ContainerFactoryPluginInterface, LocationInputInterface

4 files declare their use of LocationInputBase

ClientLocation.php in src/Plugin/geolocation/LocationInput/ClientLocation.php

Coordinates.php in src/Plugin/geolocation/LocationInput/Coordinates.php

Geocoder.php in src/Plugin/geolocation/LocationInput/Geocoder.php

Location.php in src/Plugin/geolocation/LocationInput/Location.php

File

src/LocationInputBase.php, line 15

Namespace

Drupal\geolocation

abstract class LocationInputBase extends PluginBase implements LocationInputInterface, ContainerFactoryPluginInterface {

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition);
  }

  /**
   * {@inheritdoc}
   */
  public static function getDefaultSettings() {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function getSettings(array $settings) {
    $default_settings = (array) $this
      ->getDefaultSettings();
    $settings = array_replace_recursive($default_settings, $settings);
    return $settings;
  }

  /**
   * {@inheritdoc}
   */
  public function getSettingsForm($option_id = NULL, array $settings = [], $context = NULL) {
    return [];
  }

  /**
   * {@inheritdoc}
   */
  public function validateSettingsForm(array $values, FormStateInterface $form_state) {
  }

  /**
   * {@inheritdoc}
   */
  public function getAvailableLocationInputOptions($context) {
    return [
      $this
        ->getPluginId() => $this
        ->getPluginDefinition()['name'],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getCoordinates($form_value, $option_id, array $option_settings, $context = NULL) {
    if (empty($form_value['coordinates']) || !is_array($form_value['coordinates']) || !isset($form_value['coordinates']['lat']) || !isset($form_value['coordinates']['lng']) || $form_value['coordinates']['lng'] === '' || $form_value['coordinates']['lng'] === '') {
      return FALSE;
    }
    return [
      'lat' => (double) $form_value['coordinates']['lat'],
      'lng' => (double) $form_value['coordinates']['lng'],
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getForm($center_option_id, array $center_option_settings, $context = NULL, array $default_value = NULL) {
    $form['coordinates'] = [
      '#type' => 'geolocation_input',
      '#title' => $this
        ->t('Coordinates'),
    ];
    if (!empty($default_value)) {
      $form['coordinates']['#default_value'] = $default_value;
    }
    return $form;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
DependencySerializationTrait::$_entityStorages	protected	property	An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds	protected	property	An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep	public	function		1
DependencySerializationTrait::__wakeup	public	function		2
LocationInputBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	2
LocationInputBase::getAvailableLocationInputOptions	public	function	For one LocationInput (i.e. boundary filter), return all options. Overrides LocationInputInterface::getAvailableLocationInputOptions	1
LocationInputBase::getCoordinates	public	function	Get center value. Overrides LocationInputInterface::getCoordinates	2
LocationInputBase::getDefaultSettings	public static	function	Provide a populated settings array. Overrides LocationInputInterface::getDefaultSettings	3
LocationInputBase::getForm	public	function	Get center form. Overrides LocationInputInterface::getForm	3
LocationInputBase::getSettings	public	function	Provide LocationInput option specific settings. Overrides LocationInputInterface::getSettings
LocationInputBase::getSettingsForm	public	function	Settings form by ID and context. Overrides LocationInputInterface::getSettingsForm	3
LocationInputBase::validateSettingsForm	public	function
MessengerTrait::$messenger	protected	property	The messenger.	29
MessengerTrait::messenger	public	function	Gets the messenger.	29
MessengerTrait::setMessenger	public	function	Sets the messenger.
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
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.