class ip_geoloc_plugin_style_map in IP Geolocation Views & Maps 7

Hierarchy

class \views_object
- class \views_plugin
  - class \views_plugin_style
    class \ip_geoloc_plugin_style_map

Expanded class hierarchy of ip_geoloc_plugin_style_map

2 string references to 'ip_geoloc_plugin_style_map'

ip_geoloc_plugin_style_extract_locations in views/ip_geoloc_plugin_style.inc: Extract an array of locations from the supplied views_plugin_style.
ip_geoloc_views_plugins in views/ip_geoloc.views.inc: Implements hook_views_plugins().

File

views/ip_geoloc_plugin_style_map.inc, line 12

View source

class ip_geoloc_plugin_style_map extends views_plugin_style {

  /**
   * Set default map options.
   */
  public function option_definition() {
    $options = parent::option_definition();
    $latitude = module_exists('location') ? 'location_latitude' : 'ip_geoloc_latitude';

    // For field-based modules.
    $longitude = module_exists('location') ? 'location_longitude' : ($latitude == 'ip_geoloc_latitude' ? 'ip_geoloc_longitude' : $latitude);
    $options['ip_geoloc_views_plugin_latitude'] = array(
      'default' => $latitude,
    );
    $options['ip_geoloc_views_plugin_longitude'] = array(
      'default' => $longitude,
    );
    $options['differentiator'] = array(
      'contains' => array(
        'differentiator_field' => array(
          'default' => '',
        ),
      ),
    );
    $options['default_marker_color'] = array(
      'default' => '',
    );
    $options['center_option'] = array(
      'default' => IP_GEOLOC_MAP_CENTER_ON_FIRST_LOCATION,
    );
    $options['visitor_marker'] = array(
      'default' => '<none>',
    );
    $options['gps_roles'] = array(
      'default' => array(
        DRUPAL_ANONYMOUS_RID => DRUPAL_ANONYMOUS_RID,
        DRUPAL_AUTHENTICATED_RID => DRUPAL_AUTHENTICATED_RID,
      ),
    );
    $options['map_options'] = array(
      'default' => '',
    );
    $options['map_div_style'] = array(
      'default' => '',
    );
    $options['empty_map_center'] = array(
      'default' => '',
    );
    $options['open_balloons'] = array(
      'default' => '',
    );
    return $options;
  }

  /**
   * Create the options form.
   */
  public function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form_state['renderer'] = 'google';
    $weight = 10;
    ip_geoloc_plugin_style_bulk_of_form($this, $weight, $form, $form_state);
    unset($form['center_option']['#options'][IP_GEOLOC_MAP_CENTER_OF_LOCATIONS]);
    $form['center_option']['#options'][IP_GEOLOC_MAP_CENTER_ON_VISITOR_AND_LOCATIONS] = t('Auto-box and zoom to fit all locations, including the visitor location.');
    $form['center_option']['#options'][IP_GEOLOC_MAP_CENTER_OF_LOCATIONS] = t('Auto-box and zoom to fit all locations, except for the visitor location, but display it if requested below.');
    $form['map_options'] = array(
      '#title' => t('Map options'),
      '#type' => 'textarea',
      '#size' => 3,
      '#default_value' => $this->options['map_options'],
      '#description' => t("If left blank, the default %default_options will produce a world map zoomed in to level 2 (subject to the centering option selected). A list of map options can be found <a href='!google_map_docs'>here</a>. Remember to separate options with comma's, not semi-colons, and make sure your (double) quotes match.<br/>These options apply a grey hue to all roads and set the marker balloon separator as well:<br/>%example_options", array(
        '%default_options' => IP_GEOLOC_RECENT_VISITORS_MAP_OPTIONS,
        '%example_options' => IP_GEOLOC_EXAMPLE_MAP_OPTIONS,
        '!google_map_docs' => IP_GEOLOC_DOC_GOOGLE_MAP_OPTIONS,
      )),
      '#weight' => 35,
    );
    $desc1 = t('If left blank, the default %default_style will result in a map of 300 pixels high, with a width bounded by the element that contains it. Separate style settings with semi-colons. Do not enter quotes or equal signs.', array(
      '%default_style' => IP_GEOLOC_MAP_DIV_DEFAULT_STYLE,
    ));
    $desc2 = t('You may also enter <em>&lt;none&gt;</em>. In this case you <em>must</em> set the height through CSS or the map will not show. You can use this selector to target the map: <em>#ip-geoloc-map-of-view-VIEWNAME-DISPLAYNAME</em>');
    $form['map_div_style'] = array(
      '#title' => t('Map style (CSS attributes)'),
      '#type' => 'textfield',
      '#size' => 127,
      '#maxlength' => 511,
      '#default_value' => $this->options['map_div_style'],
      '#description' => "{$desc1}<br/>{$desc2}",
      '#weight' => 37,
    );
    $form['visitor_marker'] = array(
      '#title' => t('Visitor marker color'),
      '#type' => 'textfield',
      '#size' => 6,
      '#default_value' => $this->options['visitor_marker'],
      '#description' => t("Show visitor marker in the color specified. %color_code is bright green. Note that an additional web service call will be made to retrieve the marker image, unless this field is left blank, which will result in a standard red marker. Enter <em>&lt;none&gt;</em> if you do not wish to display the visitor's current location.", array(
        '%color_code' => '00FF00',
      )),
      '#weight' => 90,
    );
    $form['gps_roles'] = array(
      '#title' => t('Roles for which HTML5-style visitor location retrieval is to be applied'),
      '#type' => 'checkboxes',
      '#default_value' => $this->options['gps_roles'],
      '#options' => user_roles(),
      '#description' => t('This is subject to the visitor willing to share their location when prompted by their browser. If they decline, or if their roles aren\'t ticked, an IP address lookup will be attempted instead. In case the lookup fails, for instance because you have not enabled Smart IP or GeoIP, make sure you specify "centerLat" and "centerLng" in the <strong>Map options</strong> below to avoid an empty canvas.'),
      '#weight' => 95,
    );
    $form['open_balloons'] = array(
      '#title' => t('Marker balloons to open on initial display'),
      '#type' => 'textfield',
      '#default_value' => $this->options['open_balloons'],
      '#description' => t("Comma-separated list of numbers of markers that have their info balloons opened upon initial display of the map. <br/>The first marker has number 1. You may use <strong>&lt;@last&gt;</strong> to indicate the last marker among the view results. <br>Note that opening a marker balloon may cause the map to pan.", array(
        '@last' => t('last'),
      )),
      '#weight' => 115,
    );
  }

  /**
   * Validate the options form.
   */
  public function options_validate(&$form, &$form_state) {
    ip_geoloc_plugin_style_bulk_of_form_validate($form, $form_state);
  }

  /**
   * Transform the View result in a list of markers and render these on a map.
   */
  public function render() {
    if (!empty($this->view->live_preview)) {
      return t('The preview function is incompatible with Google Maps so cannot be used. Please visit the page path or block to view your map.');
    }
    $render_start = microtime(TRUE);
    ip_geoloc_plugin_style_render_fields($this);
    $locations = ip_geoloc_plugin_style_extract_locations($this);
    $open_balloon_nos = array();
    $t_last = '<' . t('last') . '>';
    foreach (explode(',', $this->options['open_balloons']) as $no) {
      $open_balloon_nos[] = trim($no) == $t_last ? count($locations) - 1 : (int) $no - 1;
    }
    foreach ($locations as $key => $location) {
      $location->open = in_array($key, $open_balloon_nos);
    }
    $map_options = empty($this->options['map_options']) ? IP_GEOLOC_RECENT_VISITORS_MAP_OPTIONS : $this->options['map_options'];
    $map_div_style = trim($this->options['map_div_style']);
    $map_div_style = empty($map_div_style) ? IP_GEOLOC_MAP_DIV_DEFAULT_STYLE : ($map_div_style == '<none>' ? ' ' : check_plain($this->options['map_div_style']));
    $marker_color = empty($this->options['default_marker_color']) ? '' : $this->options['default_marker_color'];
    if (empty($this->options['visitor_marker'])) {

      // Default to standard red marker.
      $visitor_marker = TRUE;
    }
    else {
      $visitor_marker = trim($this->options['visitor_marker']);
      $visitor_marker = strpos($visitor_marker, 'none') === FALSE ? check_plain($visitor_marker) : FALSE;
    }
    $center_option = !isset($this->options['center_option']) ? IP_GEOLOC_MAP_CENTER_ON_FIRST_LOCATION : $this->options['center_option'];
    $center_latlng = FALSE;

    // Set the behaviour for the case that there are no locations to map.
    if (empty($locations)) {
      $ll = trim($this->options['empty_map_center']);
      if (empty($ll)) {

        // No map whatsoever.
        return;
      }
      if ($ll == t('visitor')) {
        $center_option = IP_GEOLOC_MAP_CENTER_ON_VISITOR;
      }
      else {

        // Empty map centered on coordinates provided.
        list($center_lat, $center_lng) = preg_split("/[\\s,]+/", $ll);
      }
    }
    if ($visitor_marker || $center_option == IP_GEOLOC_MAP_CENTER_ON_VISITOR) {

      // Perform database IP lookup as backup/replacement for HTML5 location
      // Visitor may be moving so ignore lat/long we have on the db.
      $resample = TRUE;

      // Do not store lat/long and city as it will obliterate the
      // reverse-geocoded one.
      $store = FALSE;

      // We only need lat/long, not full street address.
      $reverse_geocode = FALSE;
      $visitor_location = ip_geoloc_get_location_by_ip(ip_address(), $resample, $store, $reverse_geocode);
      if (!isset($visitor_location['latitude'])) {

        // If everything failed use whatever we have on the database.
        $visitor_location = db_query('SELECT * FROM {ip_geoloc} WHERE ip_address = :ip_address', array(
          ':ip_address' => ip_address(),
        ))
          ->fetchAssoc();
      }
      if (isset($visitor_location['latitude']) && isset($visitor_location['longitude'])) {
        $center_latlng = array(
          $visitor_location['latitude'],
          $visitor_location['longitude'],
        );
      }
    }
    if (!empty($locations) && $center_option == IP_GEOLOC_MAP_CENTER_OF_LOCATIONS || $center_option == IP_GEOLOC_MAP_CENTER_OF_LOCATIONS_WEIGHTED) {
      list($center_lat, $center_lng) = ip_geoloc_center_of_locations($locations, $center_option == IP_GEOLOC_MAP_CENTER_OF_LOCATIONS_WEIGHTED);
    }
    if (isset($center_lat) && isset($center_lng)) {
      $map_options = drupal_substr($map_options, 0, strrpos($map_options, '}'));
      $map_options = $map_options . ', "centerLat":' . $center_lat . ', "centerLng":' . $center_lng . '}';
    }
    global $user;
    $gps_roles = empty($this->options['gps_roles']) ? array(
      DRUPAL_ANONYMOUS_RID,
      DRUPAL_AUTHENTICATED_RID,
    ) : $this->options['gps_roles'];
    $gps_roles_applicable = array_intersect($gps_roles, array_keys($user->roles));
    $output = theme(array(
      'ip_geoloc_map',
    ), array(
      'view' => $this->view,
      'locations' => $locations,
      'div_id' => 'ip-geoloc-map-of-view-' . $this->view->name . '-' . $this->display->id,
      'map_options' => $map_options,
      'map_style' => $map_div_style,
      'marker_color' => $marker_color,
      'visitor_marker' => $visitor_marker,
      'center_option' => $center_option,
      'center_latlng' => $center_latlng,
      'visitor_location_gps' => !empty($gps_roles_applicable),
    ));
    ip_geoloc_debug(t('-- Google map preparation time: %sec s', array(
      '%sec' => number_format(microtime(TRUE) - $render_start, 2),
    )));
    return $output;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ip_geoloc_plugin_style_map::options_form	public	function	Create the options form. Overrides views_plugin_style::options_form
ip_geoloc_plugin_style_map::options_validate	public	function	Validate the options form. Overrides views_plugin_style::options_validate
ip_geoloc_plugin_style_map::option_definition	public	function	Set default map options. Overrides views_plugin_style::option_definition
ip_geoloc_plugin_style_map::render	public	function	Transform the View result in a list of markers and render these on a map. Overrides views_plugin_style::render
views_object::$definition	public	property	Handler's definition.
views_object::$options	public	property	Except for displays, options for the object will be held here.	1
views_object::altered_option_definition		function	Collect this handler's option definition and alter them, ready for use.
views_object::construct	public	function	Views handlers use a special construct function.	4
views_object::export_option	public	function		1
views_object::export_options	public	function
views_object::export_option_always	public	function	Always exports the option, regardless of the default value.
views_object::options Deprecated	public	function	Set default options on this object.	1
views_object::set_default_options	public	function	Set default options.
views_object::set_definition	public	function	Let the handler know what its full definition is.
views_object::unpack_options	public	function	Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable	public	function	Unpack a single option definition.
views_object::unpack_translatables	public	function	Unpacks each handler to store translatable texts.
views_object::_set_option_defaults	public	function
views_plugin::$display	public	property	The current used views display.
views_plugin::$plugin_name	public	property	The plugin name of this plugin, for example table or full.
views_plugin::$plugin_type	public	property	The plugin type of this plugin, for example style or query.
views_plugin::$view	public	property	The top object of a view. Overrides views_object::$view	1
views_plugin::additional_theme_functions	public	function	Provide a list of additional theme functions for the theme info page.
views_plugin::options_submit	public	function	Handle any special handling on the validate form.	9
views_plugin::plugin_title	public	function	Return the human readable name of the display.
views_plugin::summary_title	public	function	Returns the summary of the settings in the display.	8
views_plugin::theme_functions	public	function	Provide a full list of possible theme templates used by this style.
views_plugin_style::$row_plugin	public	property	The row plugin, if it's initialized and the style itself supports it.
views_plugin_style::$row_tokens	public	property	Store all available tokens row rows.
views_plugin_style::build_sort	public	function	Called by the view builder to see if this style handler wants to interfere with the sorts. If so it should build; if it returns any non-TRUE value, normal sorting will NOT be added to the query.	1
views_plugin_style::build_sort_post	public	function	Called by the view builder to let the style build a second set of sorts that will come after any other sorts in the view.	1
views_plugin_style::destroy	public	function	Destructor. Overrides views_object::destroy
views_plugin_style::even_empty	public	function	Should the output of the style plugin be rendered even if it's empty.	1
views_plugin_style::get_field	public	function	Get a rendered field.
views_plugin_style::get_field_value	public	function	Get the raw field value.
views_plugin_style::get_row_class	public	function	Return the token replaced row class for the specified row.
views_plugin_style::init	public	function	Initialize a style plugin.
views_plugin_style::pre_render	public	function	Allow the style to do stuff before each row is rendered.
views_plugin_style::query	public	function	Add anything to the query that we might need to. Overrides views_plugin::query	2
views_plugin_style::render_fields	public	function	Render all of the fields for a given style and store them on the object.
views_plugin_style::render_grouping	public	function	Group records as needed for rendering.
views_plugin_style::render_grouping_sets	public	function	Render the grouping sets.
views_plugin_style::tokenize_value	public	function	Take a value and apply token replacement logic to it.
views_plugin_style::uses_fields	public	function	Return TRUE if this style also uses fields.
views_plugin_style::uses_row_class	public	function	Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_row_plugin	public	function	Return TRUE if this style also uses a row plugin.
views_plugin_style::uses_tokens	public	function	Return TRUE if this style uses tokens.
views_plugin_style::validate	public	function	Validate that the plugin is correct and can be saved. Overrides views_plugin::validate

You are here

class ip_geoloc_plugin_style_map in IP Geolocation Views & Maps 7

Hierarchy

File

Members

API Navigation