class IpStack in Geolocation Field 8.3

Fixed coordinates map center.

Plugin annotation

@Location(
  id = "ipstack",
  name = @Translation("ipstack Service"),
  description = @Translation("See https://ipstack.com/ website. Limited to 10000 requests per month. Access key required."),
)

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
      • class \Drupal\geolocation\Plugin\geolocation\Location\IpStack implements LocationInterface

2 string references to 'IpStack'

geolocation.location.schema.yml in config/schema/geolocation.location.schema.yml

config/schema/geolocation.location.schema.yml

geolocation.map_center_options.schema.yml in config/schema/geolocation.map_center_options.schema.yml

config/schema/geolocation.map_center_options.schema.yml

File

src/Plugin/geolocation/Location/IpStack.php, line 17

Namespace

Drupal\geolocation\Plugin\geolocation\Location

class IpStack extends LocationBase implements LocationInterface {

  /**
   * {@inheritdoc}
   */
  public static function getDefaultSettings() {
    return [
      'access_key' => '',
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function getSettingsForm($option_id = NULL, array $settings = [], $context = NULL) {
    $settings = $this
      ->getSettings($settings);
    $form['access_key'] = [
      '#type' => 'textfield',
      '#title' => $this
        ->t('Access Key'),
      '#default_value' => $settings['access_key'],
      '#size' => 60,
      '#maxlength' => 128,
    ];
    return $form;
  }

  /**
   * {@inheritdoc}
   */
  public function getCoordinates($center_option_id, array $center_option_settings, $context = NULL) {
    $settings = $this
      ->getSettings($center_option_settings);

    // Access Key is required.
    if (empty($settings['access_key'])) {
      return [];
    }

    // Get client IP.
    $ip = \Drupal::request()
      ->getClientIp();
    if (empty($ip)) {
      return [];
    }

    // Get data from api.ipstack.com.
    $json = file_get_contents("http://api.ipstack.com/" . $ip . "?access_key=" . $settings['access_key']);
    if (empty($json)) {
      return [];
    }
    $result = json_decode($json, TRUE);
    if (empty($result) || empty($result['latitude']) || empty($result['longitude'])) {
      return [];
    }
    return [
      'lat' => (double) $result['latitude'],
      'lng' => (double) $result['longitude'],
    ];
  }

}

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
IpStack::getCoordinates	public	function	Get map location. Overrides LocationBase::getCoordinates
IpStack::getDefaultSettings	public static	function	Provide a populated settings array. Overrides LocationBase::getDefaultSettings
IpStack::getSettingsForm	public	function	Settings form by ID and context. Overrides LocationBase::getSettingsForm
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::getSettings	public	function	Provide Location option specific settings. Overrides LocationInterface::getSettings
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.