geolocation-8.x-3.x-dev/src/LocationInterface.php

<?php

namespace Drupal\geolocation;

use Drupal\Component\Plugin\PluginInspectionInterface;

/**
 * Defines an interface for geolocation Location plugins.
 */
interface LocationInterface extends PluginInspectionInterface {

  /**
   * Provide a populated settings array.
   *
   * @return array
   *   The settings array with the default map settings.
   */
  public static function getDefaultSettings(): array;

  /**
   * Provide Location option specific settings.
   *
   * @param array $settings
   *   Current settings.
   *
   * @return array
   *   An array only containing keys defined in this plugin.
   */
  public function getSettings(array $settings): array;

  /**
   * Settings form by ID and context.
   *
   * @param string $location_option_id
   *   Location option ID.
   * @param array $settings
   *   The current option settings.
   * @param array $context
   *   Current context.
   *
   * @return array
   *   A form array to be integrated in whatever.
   */
  public function getSettingsForm(string $location_option_id, array $settings, array $context = []): array;

  /**
   * For one Location (i.e. boundary filter), return all options (all filters).
   *
   * @param array $context
   *   Context like field formatter, field widget or view.
   *
   * @return array<string, string>
   *   Available location options indexed by ID.
   */
  public function getAvailableLocationOptions(array $context = []): array;

  /**
   * Get map location.
   *
   * @param string $location_option_id
   *   Location option ID.
   * @param array $location_option_settings
   *   The current feature settings.
   * @param array $context
   *   Context like field formatter, field widget or view.
   *
   * @return array|null
   *   With content
   *    'lat' => latitude
   *    'lng' => longitude
   */
  public function getCoordinates(string $location_option_id, array $location_option_settings, array $context = []): ?array;

}