You are here

Home » API reference » Location Map 8.2

locationmap.module in Location Map 8.2

Same filename and directory in other branches
  1. 7.2 locationmap.module
  2. 7 locationmap.module

File

locationmap.module
View source 
<?php

/**
 * Implements hook_help().
 */
function locationmap_help($path, $arg) {
  switch ($path) {
    case 'admin/help#locationmap':
      $output = '<p>' . t('The Location Map module displays a map of your geographic location with Google Maps.') . ' ' . l(t('The page for the map'), 'locationmap') . ' ' . t('is automatically generated.') . ' ' . t('A block is also created that displays a thumbnail of the map, linking to the map page.') . ' ' . t('This can be assigned to a page region on the') . ' ' . l(t('block administration page'), 'admin/structure/block') . '.</p>';
      return $output;
  }
}

/**
 * Implements hook_menu().
 */
function locationmap_menu() {
  $items = array();
  $items['admin/config/content/locationmap'] = array(
    'title' => 'Location Map',
    'description' => 'Configure Location Map.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'locationmap_admin_settings',
    ),
    'access callback' => 'user_access',
    'access arguments' => array(
      'administer locationmap',
    ),
    'type' => MENU_NORMAL_ITEM,
    'file' => 'locationmap.admin.inc',
  );
  $items['locationmap'] = array(
    'title' => 'Our Location',
    'access callback' => TRUE,
    'page callback' => 'locationmap_page',
    'type' => MENU_SUGGESTED_ITEM,
  );
  $items['locationmap/view'] = array(
    'title' => 'View',
    'type' => MENU_DEFAULT_LOCAL_TASK,
    'weight' => -10,
  );
  $items['locationmap/edit'] = array(
    'title' => 'Edit',
    'description' => 'Configure Location Map.',
    'page callback' => 'drupal_get_form',
    'page arguments' => array(
      'locationmap_admin_settings',
    ),
    'access callback' => 'user_access',
    'access arguments' => array(
      'administer locationmap',
    ),
    'type' => MENU_LOCAL_TASK,
  );
  return $items;
}

/**
 * Implements hook_permission().
 */
function locationmap_permission() {
  return array(
    'administer locationmap' => array(
      'title' => t('administer locationmap'),
      'description' => t('Modify the address and change settings for the location map.'),
    ),
  );
}

/**
 * Menu callback; generate a page with the location map.
 */
function locationmap_page() {
  $config = config('locationmap.settings');
  $defaults = array(
    'value' => '',
    'format' => filter_default_format(),
  );
  $locationmap_info_defaults = array(
    'value' => 'Fiordland, New Zealand',
    'format' => filter_default_format(),
  );
  $path = drupal_get_path('module', 'locationmap');
  drupal_add_js('//maps.google.com/maps/api/js?v=3&sensor=false', array(
    'type' => 'external',
    'weight' => 5,
  ));
  drupal_add_js($path . '/locationmap.js', array(
    'type' => 'file',
    'weight' => 6,
    'scope' => 'footer',
  ));
  $locationmap_css_options = array(
    'preprocess' => FALSE,
  );
  drupal_add_css($path . '/locationmap.css', $locationmap_css_options);
  $locationmap_settings = array(
    'address' => $config
      ->get('address'),
    'info' => $config
      ->get('info.value'),
    'lat' => $config
      ->get('latitude'),
    'lng' => $config
      ->get('longitude'),
    'zoom' => $config
      ->get('zoom'),
    'type' => $config
      ->get('type'),
    'admin' => user_access('administer locationmap'),
  );
  if (!$locationmap_settings['info']) {
    $locationmap_settings['info'] = $locationmap_settings['address'];
  }
  drupal_add_js(array(
    'locationmap' => $locationmap_settings,
  ), 'setting');
  $output = '<div id="locationmap_body">' . $config
    ->get('body.value') . '</div>';
  $output .= theme('locationmap_map');
  $output .= '<div id="locationmap_footer">' . $config
    ->get('footer.value') . '</div>';
  if (user_access('administer locationmap')) {

    // TODO: Remove drupal_render and update to D7 desired behaviour. See http://drupal.org/update/modules/6/7#unrendered
    $form = drupal_get_form('locationmap_in_place_edit_form');
    $output .= drupal_render($form);
  }
  drupal_set_title($config
    ->get('title'));
  return $output;
}

/**
 * Returns latitude and longitude for $address or NULL if it cannot be found.
 * @returns FALSE if address not found
 */
function locationmap_geocode_for_address($address) {
  $url_options = array(
    'query' => array(
      'address' => $address,
      'sensor' => 'false',
    ),
  );
  $request_options = array(
    'max_redirects' => 10,
    'timeout' => 120,
  );
  $response = drupal_http_request(url('http://maps.googleapis.com/maps/api/geocode/json', $url_options), $request_options);
  if ($response->code == 200) {

    // Documentation on data is here: https://developers.google.com/maps/documentation/geocoding/
    $data = drupal_json_decode($response->data);

    // Check the best match. We could improve this in the future and offer some choices.
    if (isset($data['results'][0])) {
      return array(
        $data['results'][0]['geometry']['location']['lat'],
        $data['results'][0]['geometry']['location']['lng'],
      );
    }
  }
  return array();
}

/**
 * Try to get lat and lng information from address removing parts of address if not found.
 */
function locationmap_geocode_for_address_recursive($address) {
  while (TRUE) {
    $latlng = locationmap_geocode_for_address($address);
    if ($latlng) {
      return $latlng;
    }
    if (strpos($address, ',') === FALSE) {
      return FALSE;
    }
    $address = preg_replace('/[^,]+,/', '', $address, 1);
  }
  return FALSE;
}

/**
 * @todo Please document this function.
 * @see http://drupal.org/node/1354
 */
function locationmap_in_place_edit_form($form, &$form_state) {
  $form['#submit'][] = 'system_settings_form_submit';
  $form['description'] = array(
    '#prefix' => '<p>',
    '#markup' => t('Click and drag marker to fine tune position of your location. Set zoom level below.'),
    '#suffix' => '</p>',
  );
  $form['locationmap_lat'] = array(
    '#type' => 'textfield',
    '#title' => t('Latitude'),
    '#default_value' => variable_get('locationmap_lat', ''),
  );
  $form['locationmap_lng'] = array(
    '#type' => 'textfield',
    '#title' => t('Longitude'),
    '#default_value' => variable_get('locationmap_lng', ''),
  );
  $form['locationmap_zoom'] = array(
    '#type' => 'textfield',
    '#title' => t('Zoom level'),
    '#default_value' => variable_get('locationmap_zoom', ''),
  );
  $form['submit'] = array(
    '#type' => 'submit',
    '#value' => t('Save new location and zoom level'),
  );
  return $form;
}

/**
 * Implements hook_simpletest().
 */
function locationmap_simpletest() {

  // Scan through mymodule/tests directory for any .test files to tell SimpleTest module.
  $tests = file_scan_directory(drupal_get_path('module', 'locationmap') . '/tests', '/\\.test/');
  return array_keys($tests);
}

/**
 * Implements hook_block_info().
 */
function locationmap_block_info() {
  $blocks['image']['info'] = t('Location Map block');
  return $blocks;
}

/**
 * Implements hook_block_configure().
 */
function locationmap_block_configure($delta) {
  $form = array();
  switch ($delta) {
    case 'image':
      $form['info']['locationmap_block_type'] = array(
        '#type' => 'radios',
        '#title' => t('Map type'),
        '#description' => t("Select the type of map you'd like this block to display."),
        '#default_value' => variable_get('locationmap_block_type', 'image'),
        '#options' => array(
          'image' => t('Static image'),
          'interactive' => t('Interactive map'),
        ),
      );
      $form['info']['locationmap_block_mapwidth'] = array(
        '#type' => 'textfield',
        '#title' => t('Block map width'),
        '#description' => t('Provide the width of the block map in pixels'),
        '#default_value' => variable_get('locationmap_block_mapwidth', '160'),
        '#field_suffix' => 'px',
        '#description' => NULL,
        '#size' => 10,
      );
      $form['info']['locationmap_block_mapheight'] = array(
        '#type' => 'textfield',
        '#title' => t('Block map height'),
        '#description' => t('Provide the height of the block map in pixels'),
        '#default_value' => variable_get('locationmap_block_mapheight', '120'),
        '#field_suffix' => 'px',
        '#description' => NULL,
        '#size' => 10,
      );
      $form['info']['locationmap_text_top'] = array(
        '#type' => 'text_format',
        '#title' => t('Additional text to show above the image'),
        '#default_value' => variable_get('locationmap_block_text_top'),
        '#format' => isset($edit['format']) ? $edit['format'] : NULL,
      );
      break;
  }
  return $form;
}

/**
 * Implements hook_block_save().
 */
function locationmap_block_save($delta, $edit) {
  switch ($delta) {
    case 'image':
      variable_set('locationmap_block_type', $edit['locationmap_block_type']);
      variable_set('locationmap_block_mapheight', (int) $edit['locationmap_block_mapheight']);
      variable_set('locationmap_block_mapwidth', (int) $edit['locationmap_block_mapwidth']);
      variable_set('locationmap_block_text_top', $edit['locationmap_text_top']['value']);
      break;
  }
}

/**
 * Implements hook_block_view().
 */
function locationmap_block_view($delta) {
  switch ($delta) {
    case 'image':
      $texttop = variable_get('locationmap_block_text_top');
      $blocktop = $texttop ? '<div id="locationmap-block-text-top">' . $texttop . '</div>' : '';
      $block = locationmap_block_image();
      $block['content'] = $blocktop . $block['content'];
      break;
  }
  return $block;
}

/**
 * @todo Please document this function.
 * @see http://drupal.org/node/1354
 */
function locationmap_static_image_url($w = 200, $h = 150) {
  $image_url = 'http://maps.googleapis.com/maps/api/staticmap?zoom=' . variable_get('locationmap_zoom', 5);
  $image_url .= "&amp;size={$w}x{$h}";
  $image_url .= '&amp;markers=' . variable_get('locationmap_lat', 0) . ',' . variable_get('locationmap_lng', 0);
  $image_url .= "&amp;sensor=false";
  return $image_url;
}

/**
 * @todo Please document this function.
 * @see http://drupal.org/node/1354
 */
function locationmap_block_image() {
  $type = variable_get('locationmap_block_type', 'image');
  $block = array();
  $block['subject'] = variable_get('locationmap_title', t('Our Location'));
  if ($type == 'interactive') {
    $width = variable_get('locationmap_block_mapwidth', 160);
    $height = variable_get('locationmap_block_mapheight', 120);
    $path = drupal_get_path('module', 'locationmap');
    drupal_add_js('//maps.google.com/maps/api/js?v=3&sensor=false', array(
      'type' => 'external',
      'weight' => 5,
    ));
    drupal_add_js($path . '/locationmap.js', array(
      'type' => 'file',
      'weight' => 6,
      'scope' => 'footer',
    ));
    $locationmap_settings = array(
      'address' => variable_get('locationmap_address', 'Fiordland, New Zealand'),
      'info' => variable_get('locationmap_info', 'Fiordland, New Zealand'),
      'lat' => variable_get('locationmap_lat', '-46.0868686'),
      'lng' => variable_get('locationmap_lng', '166.6822074'),
      'zoom' => variable_get('locationmap_zoom', 10),
      'type' => variable_get('locationmap_type', 'G_NORMAL_MAP'),
      'admin' => user_access('administer locationmap'),
    );
    if (!$locationmap_settings['info']) {
      $locationmap_settings['info'] = $locationmap_settings['address'];
    }
    drupal_add_js(array(
      'locationmap' => $locationmap_settings,
    ), 'setting');
    $block['content'] = theme('locationmap_map', array(
      'width' => $width,
      'height' => $height,
    ));
  }
  else {
    $block['content'] = theme('locationmap_block_image_link');
  }
  return $block;
}

/**
 * Format static image for display in the block.
 * @ingroup themeable
 */
function theme_locationmap_block_image_link() {
  $mapwidth = variable_get('locationmap_block_mapwidth', 160);
  $mapheight = variable_get('locationmap_block_mapheight', 120);
  return l('<img src="' . locationmap_static_image_url($mapwidth, $mapheight) . '" alt="Location map" />', 'locationmap', array(
    'html' => TRUE,
  ));
}

/**
 * Format div to display a location map.
 *
 * @ingroup themeable
 */
function theme_locationmap_map($variables) {
  if (empty($variables['width'])) {
    $width = variable_get('locationmap_width', '500') . 'px';
  }
  else {
    $width = $variables['width'] . 'px';
  }
  if (empty($variables['height'])) {
    $height = variable_get('locationmap_height', '500') . 'px';
  }
  else {
    $height = $variables['height'] . 'px';
  }
  return '<div id="locationmap_map" style="width: ' . $width . '; height: ' . $height . '"></div>';
}

/**
 * Implements hook_theme().
 */
function locationmap_theme() {
  return array(
    'locationmap_block_image_link' => array(),
    'locationmap_map' => array(
      'variables' => array(
        'width' => NULL,
        'height' => NULL,
      ),
    ),
  );
}

Functions

Namesort descending Description
locationmap_block_configure Implements hook_block_configure().
locationmap_block_image @todo Please document this function.
locationmap_block_info Implements hook_block_info().
locationmap_block_save Implements hook_block_save().
locationmap_block_view Implements hook_block_view().
locationmap_geocode_for_address Returns latitude and longitude for $address or NULL if it cannot be found. @returns FALSE if address not found
locationmap_geocode_for_address_recursive Try to get lat and lng information from address removing parts of address if not found.
locationmap_help Implements hook_help().
locationmap_in_place_edit_form @todo Please document this function.
locationmap_menu Implements hook_menu().
locationmap_page Menu callback; generate a page with the location map.
locationmap_permission Implements hook_permission().
locationmap_simpletest Implements hook_simpletest().
locationmap_static_image_url @todo Please document this function.
locationmap_theme Implements hook_theme().
theme_locationmap_block_image_link Format static image for display in the block.
theme_locationmap_map Format div to display a location map.