leaflet_geojson.api.php in Leaflet GeoJSON 8

Hooks provided by the Leaflet GeoJSON module.

File

leaflet_geojson.api.php

<?php

/**
 * @file
 * Hooks provided by the Leaflet GeoJSON module.
 */

/**
 * @addtogroup hooks
 * @{
 */

/**
 * Defines one or more Leaflet GeoJSON sources.
 *
 * Note: The ids should be valid PHP identifiers.
 *
 * @see hook_leaflet_geojson_source_info_alter()
 *
 * @return array
 *   An associative array of sources, keyed by a unique
 *   identifier and containing associative arrays with the following keys:
 *   - title: A human readable title for the source.
 *   - url: The GeoJSON source url.
 *   - bbox: (optional) Set to TRUE to activate the Bounding Box strategy.
 *   - bbox_arg_id: (optional) Specify the bbox argument identifier.
 *       Defaults to 'bbox'.
 *   - type: (optional) The type of source, for example views_geojson.
 *   - ... (optional) further parameters specific to the source type.
 */
function hook_leaflet_geojson_source_info() {
  $sources = [];
  $sources['simple_source'] = [
    'title' => 'My Source',
    'url' => 'http://example.com',
  ];
  $sources['views_geojson_source'] = [
    'title' => 'My Source',
    'url' => 'http://example.com',
    'bbox' => TRUE,
    'bbox_arg_id' => 'bbox',
    'type' => 'views_geojson',
    'view' => 'view_name',
    'view_display' => 'view_display_name',
  ];
  return $sources;
}

/**
 * Alter the Leaflet GeoJSON source info.
 *
 * @param array $infos
 *   The source info array, keyed by source identifier.
 *
 * @see hook_leaflet_geojson_source_info()
 */
function hook_leaflet_geojson_source_info_alter(array &$infos) {
  $infos['simple_source']['url'] = 'http://somewhere.else';
}

Functions

Name	Description
hook_leaflet_geojson_source_info	Defines one or more Leaflet GeoJSON sources.
hook_leaflet_geojson_source_info_alter	Alter the Leaflet GeoJSON source info.