geofield.widgets.openlayers.inc in Geofield 7.2

Provides widget hooks on behalf of Openlayers.

File

geofield.widgets.openlayers.inc

<?php

/**
 * @file
 * Provides widget hooks on behalf of Openlayers.
 */

/**
 * Implements hook_field_widget_info().
 */
function openlayers_field_widget_info() {
  $widgets = array();
  $widgets['geofield_openlayers'] = array(
    'label' => t('Openlayers Map'),
    'field types' => array(
      'geofield',
    ),
    'behaviors' => array(
      'multiple values' => FIELD_BEHAVIOR_CUSTOM,
    ),
  );
  return $widgets;
}

/**
 * Implements hook_field_widget_settings_form().
 */
function openlayers_field_widget_settings_form($field, $instance) {
  $widget = $instance['widget'];
  $settings = $widget['settings'];
  $form = array();

  // Get preset options, filtered to those which have the GeoField behavior and *don't* have the draw features behavior, which is incompatible
  $maps = openlayers_maps();
  $map_options = array();
  foreach ($maps as $map) {
    if (array_key_exists('openlayers_behavior_geofield', $map->data['behaviors']) && !array_key_exists('openlayers_behavior_drawfeatures', $map->data['behaviors'])) {
      $map_options[$map->name] = $map->title;
    }
  }
  if (empty($map_options)) {
    form_set_error('openlayers_map', "Error: You have no compatible openlayers maps. Make sure that at least one preset has the 'GeoField' behavior enabled and that it does not have the 'Draw Features' behavior enabled (which is incompatible).");
  }
  $form['openlayers_map'] = array(
    '#type' => 'select',
    '#title' => t('OpenLayers Map'),
    '#default_value' => isset($settings['openlayers_map']) ? $settings['openlayers_map'] : 'geofield_widget_map',
    '#options' => $map_options,
    '#description' => t('Select which OpenLayers map you would like to use. Only maps which have the GeoField behavior may be selected. If your preferred map is not here, add the GeoField behavior to it first. The "Draw Features" bahavior is incompatible - presets with this behavior are not shown.'),
  );
  $form['data_storage'] = array(
    '#type' => 'radios',
    '#title' => t('Storage Options'),
    '#description' => t('Should the widget only allow simple features (points, lines, or polygons), or should the widget allow for complex features? Note that changing this setting from complex to simple after data has been entered can lead to data loss.'),
    '#options' => array(
      'single' => 'Store each simple feature as a separate field.',
      'collection' => 'Store as a single collection.',
    ),
    '#default_value' => isset($settings['data_storage']) ? $settings['data_storage'] : 'single',
  );
  $form['feature_types'] = array(
    '#title' => t('Available Features'),
    '#type' => 'checkboxes',
    '#options' => array(
      'point' => t('Point'),
      'path' => t('Path'),
      'polygon' => t('Polygon'),
    ),
    '#description' => t('Select what features are available to draw.'),
    '#default_value' => isset($settings['feature_types']) ? $settings['feature_types'] : array(
      'point' => 'point',
      'path' => 'path',
      'polygon' => 'polygon',
    ),
  );
  $form['allow_edit'] = array(
    '#title' => t('Allow shape modification'),
    '#type' => 'checkbox',
    '#description' => t('Can you edit and delete shapes.'),
    '#default_value' => isset($settings['allow_edit']) ? $settings['allow_edit'] : 1,
  );

  // Add optional Geocoder support.
  $use_geocoder = isset($settings['use_geocoder']) ? $settings['use_geocoder'] : 0;
  $geocoder_form = array(
    '#type' => 'fieldset',
    '#title' => t('Geocoder settings'),
  );
  if (module_exists('geocoder')) {
    $geocoder_form['use_geocoder'] = array(
      '#type' => 'checkbox',
      '#title' => t('Enable geocoding of location data'),
      '#default_value' => $use_geocoder,
      // Can't nest this in a fieldset element without affecting data storage so instead hardcode one.
      '#prefix' => '<fieldset><legend><span="fieldset-legend">' . t('Geocoder settings') . '</span></legend><div class="fieldset-wrapper">',
    );

    // Load the Geocoder widget settings.
    module_load_include('inc', 'geocoder', 'geocoder.widget');
    $new = geocoder_field_widget_settings_form($field, $instance);

    // Show the geocoder fields only if geocoder is selected.
    openlayers_widget_add_states($new, ':input[name="instance[widget][settings][use_geocoder]"]');

    // Close the fieldset we opened in the #prefix to use_geocoder.
    $element_children = element_children($new);
    $new[end($element_children)]['#suffix'] = '</div></fieldset>';
    $geocoder_form += $new;
  }
  else {
    $geocoder_form['add_geocoder'] = array(
      '#markup' => t('Optionally, install the <a href="http//drupal.org/project/geocoder">Geocoder</a> module and add an <a href="http://drupal.org/project/addressfield">Address field</a> to enable mapping by address.'),
    );
  }
  $form += $geocoder_form;
  return $form;
}

/**
 * Recurse through form elements adding a visibility #states selector
 * and removing #required flags.
 */
function openlayers_widget_add_states(&$element, $selector) {
  foreach (element_children($element) as $key) {
    $element[$key]['#required'] = FALSE;

    // Don't override any existing #states settings.
    if (!isset($element[$key]['#states'])) {
      $element[$key]['#states'] = array();
    }
    if (!isset($element[$key]['#states']['visible'])) {
      $element[$key]['#states']['visible'] = array();
    }
    $element[$key]['#states']['visible'][$selector] = array(
      'checked' => TRUE,
    );
    openlayers_widget_add_states($element[$key], $selector);
  }
}

/**
 * Implements hook_field_widget_form().
 */
function openlayers_field_widget_form(&$form, &$form_state, $field, $instance, $langcode, $items, $delta, $element) {
  geophp_load();
  $widget = $instance['widget'];
  $parents = $form['#parents'];
  $field_name = $field['field_name'];
  $id_prefix = implode('-', array_merge($parents, array(
    $field_name,
    $delta,
  )));
  $wrapper_id = drupal_html_id($id_prefix . '-use-geocoder-wrapper');
  $settings_defaults = array(
    'openlayers_map' => 'geofield_widget_map',
    'data_storage' => 'single',
    'feature_types' => array(
      'point' => 'point',
      'path' => 'path',
      'polygon' => 'polygon',
    ),
    'allow_edit' => 1,
  );
  $settings = array_merge($settings_defaults, $widget['settings']);

  // Compress all the WKT elements into a single WKT object to pass to the map.
  // Essentially we compress all the elements into delta 0, then deconstruct them on the other side when it comes time to validate them
  $geoms = array();
  foreach ($items as $delta => $item) {
    if (is_array($item) && array_key_exists('geom', $item)) {
      $geoms[] = geoPHP::load($item['geom']);
    }
    else {
      $geoms[] = geoPHP::load($item);
    }
  }
  $combined_geom = geoPHP::geometryReduce($geoms);
  if ($combined_geom) {

    // We want to force the combined_geom into a geometryCollection
    $geom_type = $combined_geom
      ->geometryType();
    if ($geom_type == 'MultiPolygon' || $geom_type == 'MultiLineString' || $geom_type == 'MultiPoint') {
      $combined_geom = new GeometryCollection($combined_geom
        ->getComponents());
    }
    $combined_wkt = $combined_geom
      ->out('wkt');

    // A value of 'GEOMETRYCOLLECTION EMPTY' breaks OpenLayers JS later on down the line.
    if ($combined_wkt == 'GEOMETRYCOLLECTION EMPTY') {
      $combined_wkt = '';
    }
  }
  else {
    $combined_wkt = '';
  }
  $element['geom'] = array(
    '#type' => 'hidden',
    '#attributes' => array(
      'class' => array(
        'geofield_wkt',
      ),
    ),
    '#default_value' => $combined_wkt,
    '#required' => isset($instance['required']) ? $instance['required'] : FALSE,
  );
  $element['input_format']['#value'] = GEOFIELD_INPUT_WKT;
  $openlayers_map_id = !empty($instance['widget']['settings']['openlayers_map']) ? $instance['widget']['settings']['openlayers_map'] : 'geofield_widget_map';
  $element['#openlayers_mapname'] = $openlayers_map_id;
  $element['#after_build'] = array(
    'openlayers_geofield_widget_afterbuild',
  );
  $element['#data_storage'] = !empty($settings['data_storage']) ? $settings['data_storage'] : 'collection';

  // Attach the widget and field settings so they can be accesses by JS and validate functions
  $element['#widget_settings'] = $settings;
  $element['#widget_settings']['allow_edit'] = (bool) $settings['allow_edit'];
  $element['#widget_settings']['feature_types'] = array();
  foreach ($settings['feature_types'] as $feature => $feature_setting) {
    if ($feature_setting) {
      $element['#widget_settings']['feature_types'][] = $feature;
    }
  }
  $element['#widget_settings']['cardinality'] = $field['cardinality'];

  // Make sure we set the input-format to WKT so geofield knows how to process it
  $element['input_format'] = array(
    '#type' => 'value',
    '#value' => GEOFIELD_INPUT_WKT,
  );

  // Time to deal with optional geocoder integration
  // Conditionally add geocoder button.
  $is_settings_form = isset($form['#title']) && $form['#title'] == t('Default value');
  if (!$is_settings_form && !empty($settings['use_geocoder']) && !empty($settings['geocoder_field'])) {
    if ($field = field_info_instance($instance['entity_type'], $settings['geocoder_field'], $instance['bundle'])) {
      $label = $field['label'];
    }
    else {
      switch ($settings['geocoder_field']) {
        case 'title':
          $label = t('Title');
          break;
        case 'name':
          $label = t('Name');
          break;
        default:
          $label = $settings['geocoder_field'];
      }
    }
    $element['#prefix'] = '<div id="' . $wrapper_id . '">';
    $element['#suffix'] = '</div>';
    $element['use_geocoder'] = array(
      '#type' => 'submit',
      '#name' => strtr($id_prefix, '-', '_') . '_use_geocoder',
      '#value' => t('Find using @field field', array(
        '@field' => $label,
      )),
      '#attributes' => array(
        'class' => array(
          'field-use-geocoder-submit',
        ),
      ),
      // Avoid validation errors for e.g. required fields but do pass the value of the geocoder field.
      '#limit_validation_errors' => array(
        array_merge($parents, array(
          $field_name,
          $langcode,
        )),
        array(
          $settings['geocoder_field'],
          $langcode,
        ),
      ),
      '#ajax' => array(
        'callback' => 'openlayers_widget_geocode',
        'wrapper' => $wrapper_id,
        'effect' => 'fade',
      ),
      '#submit' => array(
        'openlayers_use_geocoder_submit',
      ),
    );
  }

  // Add the element to an array, because it's the format that FIELD_BEHAVIOR_CUSTOM expects
  $full_element = array(
    $element,
  );

  // Override the element_validate as we need to deal with deltas
  unset($full_element[0]['#element_validate']);
  $full_element['#element_validate'][] = 'openlayers_geofield_widget_element_validate';
  return $full_element;
}

/**
 * Callback for afterbuild for widget for js addition to
 */
function openlayers_geofield_widget_afterbuild($element, &$form_state) {
  $defaults = array();
  $element['geofield_openlayers_map'] = array(
    '#markup' => '<div class="form-item geofield-openlayers-map" style="display:block">' . openlayers_geofield_form_latlon_map(array(), $element['#openlayers_mapname']) . '</div>',
  );
  $element['geofield_openlayers_map_desc'] = array(
    '#markup' => '<div class="description geofield-help">' . t('Use the icons to select what type of feature to draw. Each map can contain one simple feature. Pan and zoom with arrows and the zoom bar.') . '</div>',
  );
  drupal_add_js(array(
    'geofield' => array(
      'widget_settings' => $element['#widget_settings'],
    ),
  ), 'setting');
  return $element;
}

/**
 * Create LatLon Helper Map.
 */
function openlayers_geofield_form_latlon_map($defaults = array(), $map_name) {

  // Pass variables etc. to javascript
  // Set up our map to help set lat and lon
  // This map will always be projected as 4326 and use just the default map preset
  $map_data = openlayers_map_load($map_name);
  $map = $map_data->data;
  return openlayers_render_map($map);
}

/**
 * Submit callback for widget form.
 */
function openlayers_use_geocoder_submit($form, &$form_state) {
  $button = $form_state['triggering_element'];

  // Go one level up in the form, to the widgets container.
  $element = drupal_array_get_nested_value($form, array_slice($button['#array_parents'], 0, -1));
  $field_name = $element['#field_name'];
  $langcode = $element['#language'];
  $delta = $element['#delta'];
  $parents = $element['#field_parents'];

  // Set the widget value based on geocoding results.
  $field_state = field_form_get_state($parents, $field_name, $langcode, $form_state);
  $geocoder_field = $field_state['instance']['widget']['settings']['geocoder_field'];
  if ($field_value = geocoder_widget_get_field_value($element['#entity_type'], $field_state['instance'], NULL, $form_state['values'][$geocoder_field][$langcode])) {
    geophp_load();
    $geometry = geoPHP::load($field_value[$langcode][$delta]['geom']);
    $field_value[$langcode][$delta]['geom'] = $geometry
      ->out('wkt');

    // OpenLayers can only use WKT, so translate
    $field_value[$langcode][$delta]['input_format'] = 'wkt';

    // Override the field's value in the 'input' array to substitute the new
    // field value for the one that was submitted.
    drupal_array_set_nested_value($form_state, array_merge(array(
      'values',
    ), $parents, array(
      $field_name,
    )), $field_value);
  }
}

/**
 * Return the altered form element from an AJAX request.
 *
 * @see openlayers_field_widget_form()
 */
function openlayers_widget_geocode($form, $form_state) {
  $button = $form_state['triggering_element'];

  // Go one level up in the form, to the widgets container.
  $element = drupal_array_get_nested_value($form, array_slice($button['#array_parents'], 0, -1));
  $field_name = $element['#field_name'];
  $langcode = $element['#language'];
  $delta = $element['#delta'];
  $parents = $element['#field_parents'];
  $value = drupal_array_get_nested_value($form_state, array_merge(array(
    'values',
  ), $parents, array(
    $field_name,
  )));
  $element['geom']['#value'] = $value[$langcode][$delta]['geom'];

  // Return the map, but remove the '_weight' element inserted
  // by the field API.
  unset($element['_weight']);
  return $element;
}
function openlayers_geofield_widget_element_validate($element, &$form_state) {
  $container_delta = $element[0];
  if (!empty($container_delta['geom']['#value'])) {
    geophp_load();
    $combined_geom = geoPHP::load($container_delta['geom']['#value']);
    $combined_geom = geoPHP::geometryReduce($combined_geom);

    // Check to make sure they only saved the allowed types
    $geom_type = $combined_geom
      ->geometryType();
    if ($geom_type == 'GeometryCollection' || $geom_type == 'MultiPoint' || $geom_type == 'MultiLineString' || $geom_type == 'MultiPolygon') {
      $geoms = $combined_geom
        ->getComponents();
    }
    else {
      $geoms = array(
        $combined_geom,
      );
    }
    foreach ($geoms as $item) {
      $allowed = FALSE;
      foreach ($container_delta['#widget_settings']['feature_types'] as $type) {
        $geometry_type = strtolower($item
          ->geometryType());
        if ($geometry_type == 'linestring') {
          $geometry_type = 'path';
        }
        if (strpos(strtolower($geometry_type), $type) !== FALSE) {
          $allowed = TRUE;
          break;
        }
      }
      if (!$allowed) {
        form_set_error($container_delta['#field_name'], 'Not allowed to submit a geometry of type ' . $item
          ->geometryType());
        return;
      }
    }

    //Check the number deltas
    $cardinality = $container_delta['#widget_settings']['cardinality'];
    if ($cardinality > 0 && $container_delta['#widget_settings']['data_storage'] == 'single') {
      if (count($geoms) > $cardinality) {
        form_set_error($container_delta['#field_name'], 'Too many geometries submitted. Max allowed is ' . $cardinality);
        return;
      }
    }

    // Checks pass, lets load this up into deltas
    if ($container_delta['#widget_settings']['data_storage'] == 'collection') {

      //Assign values to the form state
      form_set_value($element[0]['geom'], $combined_geom
        ->out('wkt'), $form_state);
    }
    if ($container_delta['#widget_settings']['data_storage'] == 'single') {
      foreach ($geoms as $delta => $geom) {

        // Clone delta-0
        $element = $container_delta;

        // Override the delta
        openlayers_geofield_override_element_delta($element, 0, $delta);

        // Assign the value in the form_state
        form_set_value($element['geom'], $geom
          ->out('wkt'), $form_state);
      }
    }
  }
}
function openlayers_geofield_override_element_delta(&$element, $source_delta, $delta) {
  if (isset($element['#parents'])) {
    foreach ($element['#parents'] as $index => $item) {
      if (is_numeric($item) && $item == $source_delta) {
        $element['#parents'][$index] = $delta;
      }
    }
  }
  if (isset($element['#array_parents'])) {
    foreach ($element['#array_parents'] as $index => $item) {
      if ($item == $source_delta) {
        $element['#array_parents'][$index] = $delta;
      }
    }
  }
  foreach ($element as $key => &$item) {
    if (substr($key, 0, 1) != '#') {
      openlayers_geofield_override_element_delta($item, $source_delta, $delta);
    }
  }
}

Functions

Name	Description
openlayers_field_widget_form	Implements hook_field_widget_form().
openlayers_field_widget_info	Implements hook_field_widget_info().
openlayers_field_widget_settings_form	Implements hook_field_widget_settings_form().
openlayers_geofield_form_latlon_map	Create LatLon Helper Map.
openlayers_geofield_override_element_delta
openlayers_geofield_widget_afterbuild	Callback for afterbuild for widget for js addition to
openlayers_geofield_widget_element_validate
openlayers_use_geocoder_submit	Submit callback for widget form.
openlayers_widget_add_states	Recurse through form elements adding a visibility #states selector and removing #required flags.
openlayers_widget_geocode	Return the altered form element from an AJAX request.