abstract class LocationBase in Geolocation Field 8.2

Class LocationBase.

@package Drupal\geolocation

Hierarchy

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

7 files declare their use of LocationBase

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

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

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

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

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

... See full list

File

src/LocationBase.php, line 15

Namespace

Drupal\geolocation

abstract class LocationBase extends PluginBase implements LocationInterface, 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 = $this
      ->getDefaultSettings();
    $settings = array_replace_recursive($default_settings, $settings);
    return $settings;
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function getCoordinates($center_option_id, array $center_option_settings, $context = NULL) {
    return [];
  }

}

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
LocationBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	1
LocationBase::getAvailableLocationOptions	public	function	For one Location (i.e. boundary filter), return all options (all filters). Overrides LocationInterface::getAvailableLocationOptions	5
LocationBase::getCoordinates	public	function	Get map location. Overrides LocationInterface::getCoordinates	7
LocationBase::getDefaultSettings	public static	function	Provide a populated settings array. Overrides LocationInterface::getDefaultSettings	1
LocationBase::getSettings	public	function	Provide Location option specific settings. Overrides LocationInterface::getSettings
LocationBase::getSettingsForm	public	function	Settings form by ID and context. Overrides LocationInterface::getSettingsForm	1
LocationBase::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.