You are here

interface MapProviderInterface in Geolocation Field 8.3

Same name and namespace in other branches
  1. 8.2 src/MapProviderInterface.php \Drupal\geolocation\MapProviderInterface

Defines an interface for geolocation MapProvider plugins.

Hierarchy

Expanded class hierarchy of MapProviderInterface

All classes that implement MapProviderInterface

File

src/MapProviderInterface.php, line 10

Namespace

Drupal\geolocation
View source
interface MapProviderInterface extends PluginInspectionInterface {

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

  /**
   * Provide map provider specific settings ready to handover to JS.
   *
   * @param array $settings
   *   Current general map settings. Might contain unrelated settings as well.
   *
   * @return array
   *   An array only containing keys defined in this plugin.
   */
  public function getSettings(array $settings);

  /**
   * Provide a summary array to use in field formatters.
   *
   * @param array $settings
   *   The current map settings.
   *
   * @return array
   *   An array to use as field formatter summary.
   */
  public function getSettingsSummary(array $settings);

  /**
   * Provide a generic map settings form array.
   *
   * @param array $settings
   *   The current map settings.
   * @param array $parents
   *   Form parents.
   *
   * @return array
   *   A form array to be integrated in whatever.
   */
  public function getSettingsForm(array $settings, array $parents);

  /**
   * Alter render array.
   *
   * @param array $render_array
   *   Render array.
   * @param array $map_settings
   *   The current map settings.
   * @param array $context
   *   Context like field formatter, field widget or view.
   *
   * @return array
   *   Render attachments.
   */
  public function alterRenderArray(array $render_array, array $map_settings, array $context);

  /**
   * Alter common map build array.
   *
   * @param array $render_array
   *   Render array.
   * @param array $map_settings
   *   The current map settings.
   * @param array $context
   *   Context like field formatter, field widget or view.
   *
   * @return array
   *   Render attachments.
   */
  public function alterCommonMap(array $render_array, array $map_settings, array $context);

  /**
   * Return available control positions.
   *
   * @return array|false
   *   Positions.
   */
  public static function getControlPositions();

}

Members

Namesort descending Modifiers Type Description Overrides
MapProviderInterface::alterCommonMap public function Alter common map build array. 1
MapProviderInterface::alterRenderArray public function Alter render array. 1
MapProviderInterface::getControlPositions public static function Return available control positions. 1
MapProviderInterface::getDefaultSettings public static function Provide a populated settings array. 1
MapProviderInterface::getSettings public function Provide map provider specific settings ready to handover to JS. 1
MapProviderInterface::getSettingsForm public function Provide a generic map settings form array. 1
MapProviderInterface::getSettingsSummary public function Provide a summary array to use in field formatters. 1
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 4
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2