You are here

function getlocations_plugin_style_map::option_definition in Get Locations 7

Same name and namespace in other branches
  1. 6.2 getlocations_plugin_style_map.inc \getlocations_plugin_style_map::option_definition()
  2. 6 getlocations_plugin_style_map.inc \getlocations_plugin_style_map::option_definition()
  3. 7.2 views/getlocations_plugin_style_map.inc \getlocations_plugin_style_map::option_definition()

Information about options for all kinds of purposes will be held here.

@code 'option_name' => array(

  • 'default' => default value,
  • 'translatable' => (optional) TRUE/FALSE (wrap in t() on export if true),
  • 'contains' => (optional) array of items this contains, with its own defaults, etc. If contains is set, the default will be ignored and assumed to be array().
  • 'bool' => (optional) TRUE/FALSE Is the value a boolean value. This will change the export format to TRUE/FALSE instead of 1/0.
  • 'export' => (optional) FALSE or a callback for special export handling if necessary.
  • 'unpack_translatable' => (optional) callback for special handling for translating data within the option, if necessary.

),

Return value

array Returns the options of this handler/plugin.

Overrides views_plugin_style::option_definition

See also

views_object::export_option()

views_object::export_option_always()

views_object::unpack_translatable()

File

views/getlocations_plugin_style_map.inc, line 42
getlocations_plugin_style_map.inc @author Bob Hutchinson http://drupal.org/user/52366 @copyright GNU GPL

Class

getlocations_plugin_style_map
Getlocations style plugin to render rows as icons on a map.

Code

function option_definition() {
  $options = parent::option_definition();
  $getlocations_defaults = getlocations_defaults();
  $options['width'] = array(
    'default' => $getlocations_defaults['width'],
  );
  $options['height'] = array(
    'default' => $getlocations_defaults['height'],
  );
  $options['node_map_marker'] = array(
    'default' => $getlocations_defaults['node_map_marker'],
  );
  $options['user_map_marker'] = array(
    'default' => $getlocations_defaults['user_map_marker'],
  );
  $options['vocabulary_map_marker'] = array(
    'default' => $getlocations_defaults['vocabulary_map_marker'],
  );
  $options['term_map_marker'] = array(
    'default' => $getlocations_defaults['term_map_marker'],
  );
  $options['comment_map_marker'] = array(
    'default' => $getlocations_defaults['comment_map_marker'],
  );
  $options['latlong'] = array(
    'default' => $getlocations_defaults['latlong'],
  );
  $options['zoom'] = array(
    'default' => $getlocations_defaults['zoom'],
  );
  $options['minzoom_map'] = array(
    'default' => $getlocations_defaults['minzoom_map'],
  );
  $options['maxzoom_map'] = array(
    'default' => $getlocations_defaults['maxzoom_map'],
  );
  $options['controltype'] = array(
    'default' => $getlocations_defaults['controltype'],
  );
  $options['pancontrol'] = array(
    'default' => $getlocations_defaults['pancontrol'],
  );
  $options['mtc'] = array(
    'default' => $getlocations_defaults['mtc'],
  );
  $options['maptype'] = array(
    'default' => $getlocations_defaults['maptype'],
  );
  $options['baselayers'] = array(
    'default' => $getlocations_defaults['baselayers'],
  );
  $options['scale'] = array(
    'default' => $getlocations_defaults['scale'],
  );
  $options['overview'] = array(
    'default' => $getlocations_defaults['overview'],
  );
  $options['overview_opened'] = array(
    'default' => $getlocations_defaults['overview_opened'],
  );
  $options['scrollwheel'] = array(
    'default' => $getlocations_defaults['scrollwheel'],
  );
  $options['show_maplinks'] = array(
    'default' => $getlocations_defaults['show_maplinks'],
  );
  $options['show_maplinks_viewport'] = array(
    'default' => $getlocations_defaults['show_maplinks_viewport'],
  );
  $options['sv_show'] = array(
    'default' => $getlocations_defaults['sv_show'],
  );
  $options['sv_showfirst'] = array(
    'default' => $getlocations_defaults['sv_showfirst'],
  );
  $options['sv_heading'] = array(
    'default' => $getlocations_defaults['sv_heading'],
  );
  $options['sv_zoom'] = array(
    'default' => $getlocations_defaults['sv_zoom'],
  );
  $options['sv_pitch'] = array(
    'default' => $getlocations_defaults['sv_pitch'],
  );
  $options['fullscreen'] = array(
    'default' => $getlocations_defaults['fullscreen'],
  );
  $options['show_bubble_on_one_marker'] = array(
    'default' => $getlocations_defaults['show_bubble_on_one_marker'],
  );
  $options['trafficinfo'] = array(
    'default' => $getlocations_defaults['trafficinfo'],
  );
  $options['trafficinfo_state'] = array(
    'default' => $getlocations_defaults['trafficinfo_state'],
  );
  $options['bicycleinfo'] = array(
    'default' => $getlocations_defaults['bicycleinfo'],
  );
  $options['bicycleinfo_state'] = array(
    'default' => $getlocations_defaults['bicycleinfo_state'],
  );
  $options['transitinfo'] = array(
    'default' => $getlocations_defaults['transitinfo'],
  );
  $options['transitinfo_state'] = array(
    'default' => $getlocations_defaults['transitinfo_state'],
  );
  $options['places'] = array(
    'default' => $getlocations_defaults['places'],
  );
  $options['poi_show'] = array(
    'default' => $getlocations_defaults['poi_show'],
  );
  $options['transit_show'] = array(
    'default' => $getlocations_defaults['transit_show'],
  );
  $options['minzoom'] = array(
    'default' => $getlocations_defaults['minzoom'],
  );
  $options['maxzoom'] = array(
    'default' => $getlocations_defaults['maxzoom'],
  );
  $options['nodezoom'] = array(
    'default' => $getlocations_defaults['nodezoom'],
  );
  $options['markeraction'] = array(
    'default' => $getlocations_defaults['markeraction'],
  );
  $options['markeractiontype'] = array(
    'default' => $getlocations_defaults['markeractiontype'],
  );
  $options['markeraction_click_zoom'] = array(
    'default' => $getlocations_defaults['markeraction_click_zoom'],
  );
  $options['markeraction_click_center'] = array(
    'default' => $getlocations_defaults['markeraction_click_center'],
  );
  $options['markermanagertype'] = array(
    'default' => $getlocations_defaults['markermanagertype'],
  );
  $options['usemarkermanager'] = array(
    'default' => $getlocations_defaults['usemarkermanager'],
  );
  $options['useclustermanager'] = array(
    'default' => $getlocations_defaults['useclustermanager'],
  );
  $options['map_backgroundcolor'] = array(
    'default' => $getlocations_defaults['map_backgroundcolor'],
  );
  if (!$getlocations_defaults['markermanagertype']) {
    $options['usemarkermanager'] = 0;
    $options['useclustermanager'] = 0;
  }
  $options['markerclusterer_style'] = array(
    'default' => $getlocations_defaults['markerclusterer_style'],
  );
  $options['markerclusterer_zoom'] = array(
    'default' => $getlocations_defaults['markerclusterer_zoom'],
  );
  $options['markerclusterer_size'] = array(
    'default' => $getlocations_defaults['markerclusterer_size'],
  );
  $options['markerclusterer_minsize'] = array(
    'default' => $getlocations_defaults['markerclusterer_minsize'],
  );
  $options['markerclusterer_title'] = array(
    'default' => $getlocations_defaults['markerclusterer_title'],
  );
  $options['markerclusterer_imgpath'] = array(
    'default' => $getlocations_defaults['markerclusterer_imgpath'],
  );
  $options['pansetting'] = array(
    'default' => $getlocations_defaults['pansetting'],
  );
  $options['draggable'] = array(
    'default' => $getlocations_defaults['draggable'],
  );
  $options['styles'] = array(
    'default' => $getlocations_defaults['styles'],
  );
  $options['custom_content_enable'] = array(
    'default' => $getlocations_defaults['custom_content_enable'],
  );
  $options['custom_content_source'] = array(
    'default' => $getlocations_defaults['custom_content_source'],
  );
  $options['polygons_enable'] = array(
    'default' => $getlocations_defaults['polygons_enable'],
  );
  $options['polygons_strokecolor'] = array(
    'default' => $getlocations_defaults['polygons_strokecolor'],
  );
  $options['polygons_strokeopacity'] = array(
    'default' => $getlocations_defaults['polygons_strokeopacity'],
  );
  $options['polygons_strokeweight'] = array(
    'default' => $getlocations_defaults['polygons_strokeweight'],
  );
  $options['polygons_fillcolor'] = array(
    'default' => $getlocations_defaults['polygons_fillcolor'],
  );
  $options['polygons_fillopacity'] = array(
    'default' => $getlocations_defaults['polygons_fillopacity'],
  );
  $options['polygons_coords'] = array(
    'default' => $getlocations_defaults['polygons_coords'],
  );
  $options['polygons_clickable'] = array(
    'default' => $getlocations_defaults['polygons_clickable'],
  );
  $options['polygons_message'] = array(
    'default' => $getlocations_defaults['polygons_message'],
  );
  $options['rectangles_enable'] = array(
    'default' => $getlocations_defaults['rectangles_enable'],
  );
  $options['rectangles_strokecolor'] = array(
    'default' => $getlocations_defaults['rectangles_strokecolor'],
  );
  $options['rectangles_strokeopacity'] = array(
    'default' => $getlocations_defaults['rectangles_strokeopacity'],
  );
  $options['rectangles_strokeweight'] = array(
    'default' => $getlocations_defaults['rectangles_strokeweight'],
  );
  $options['rectangles_fillcolor'] = array(
    'default' => $getlocations_defaults['rectangles_fillcolor'],
  );
  $options['rectangles_fillopacity'] = array(
    'default' => $getlocations_defaults['rectangles_fillopacity'],
  );
  $options['rectangles_coords'] = array(
    'default' => $getlocations_defaults['rectangles_coords'],
  );
  $options['rectangles_clickable'] = array(
    'default' => $getlocations_defaults['rectangles_clickable'],
  );
  $options['rectangles_message'] = array(
    'default' => $getlocations_defaults['rectangles_message'],
  );
  $options['rectangles_apply'] = array(
    'default' => $getlocations_defaults['rectangles_apply'],
  );
  $options['rectangles_dist'] = array(
    'default' => $getlocations_defaults['rectangles_dist'],
  );
  $options['circles_enable'] = array(
    'default' => $getlocations_defaults['circles_enable'],
  );
  $options['circles_strokecolor'] = array(
    'default' => $getlocations_defaults['circles_strokecolor'],
  );
  $options['circles_strokeopacity'] = array(
    'default' => $getlocations_defaults['circles_strokeopacity'],
  );
  $options['circles_strokeweight'] = array(
    'default' => $getlocations_defaults['circles_strokeweight'],
  );
  $options['circles_fillcolor'] = array(
    'default' => $getlocations_defaults['circles_fillcolor'],
  );
  $options['circles_fillopacity'] = array(
    'default' => $getlocations_defaults['circles_fillopacity'],
  );
  $options['circles_coords'] = array(
    'default' => $getlocations_defaults['circles_coords'],
  );
  $options['circles_clickable'] = array(
    'default' => $getlocations_defaults['circles_clickable'],
  );
  $options['circles_message'] = array(
    'default' => $getlocations_defaults['circles_message'],
  );
  $options['circles_radius'] = array(
    'default' => $getlocations_defaults['circles_radius'],
  );
  $options['circles_apply'] = array(
    'default' => $getlocations_defaults['circles_apply'],
  );
  $options['polylines_enable'] = array(
    'default' => $getlocations_defaults['polylines_enable'],
  );
  $options['polylines_strokecolor'] = array(
    'default' => $getlocations_defaults['polylines_strokecolor'],
  );
  $options['polylines_strokeopacity'] = array(
    'default' => $getlocations_defaults['polylines_strokeopacity'],
  );
  $options['polylines_strokeweight'] = array(
    'default' => $getlocations_defaults['polylines_strokeweight'],
  );
  $options['polylines_coords'] = array(
    'default' => $getlocations_defaults['polylines_coords'],
  );
  $options['polylines_clickable'] = array(
    'default' => $getlocations_defaults['polylines_clickable'],
  );
  $options['polylines_message'] = array(
    'default' => $getlocations_defaults['polylines_message'],
  );
  $options['kml_url'] = array(
    'default' => $getlocations_defaults['kml_group']['kml_url'],
  );
  $options['kml_url_click'] = array(
    'default' => $getlocations_defaults['kml_group']['kml_url_click'],
  );
  $options['kml_url_infowindow'] = array(
    'default' => $getlocations_defaults['kml_group']['kml_url_infowindow'],
  );
  $options['kml_url_viewport'] = array(
    'default' => $getlocations_defaults['kml_group']['kml_url_viewport'],
  );
  $options['kml_url_button'] = array(
    'default' => $getlocations_defaults['kml_group']['kml_url_button'],
  );
  $options['kml_url_button_label'] = array(
    'default' => $getlocations_defaults['kml_group']['kml_url_button_label'],
  );
  $options['kml_url_button_state'] = array(
    'default' => $getlocations_defaults['kml_group']['kml_url_button_state'],
  );
  $options['region_bias'] = array(
    'default' => $getlocations_defaults['region_bias'],
  );
  $options['fullscreen_disable'] = array(
    'default' => $getlocations_defaults['fullscreen_disable'],
  );
  $options['search_places'] = array(
    'default' => $getlocations_defaults['search_places'],
  );
  $options['search_places_size'] = array(
    'default' => $getlocations_defaults['search_places_size'],
  );
  $options['search_places_position'] = array(
    'default' => $getlocations_defaults['search_places_position'],
  );
  $options['search_places_label'] = array(
    'default' => $getlocations_defaults['search_places_label'],
  );
  $options['search_places_placeholder'] = array(
    'default' => $getlocations_defaults['search_places_placeholder'],
  );
  $options['search_places_dd'] = array(
    'default' => $getlocations_defaults['search_places_dd'],
  );
  $options['search_places_list'] = array(
    'default' => $getlocations_defaults['search_places_list'],
  );

  // jquery_colorpicker TODO does not work in Views Getlocations | settings
  $options['jquery_colorpicker_enabled'] = array(
    'default' => 0,
  );

  #$options['jquery_colorpicker_enabled'] = array('default' => $getlocations_defaults['jquery_colorpicker_enabled']);

  // categories
  $options['category_method'] = array(
    'default' => $getlocations_defaults['category_method'],
  );
  $options['category_term_reference_field'] = array(
    'default' => $getlocations_defaults['category_term_reference_field'],
  );
  $options['category_showhide_buttons'] = array(
    'default' => $getlocations_defaults['category_showhide_buttons'],
  );

  // geojson
  $options['geojson_enable'] = array(
    'default' => $getlocations_defaults['geojson_enable'],
  );
  $options['geojson_options'] = array(
    'default' => $getlocations_defaults['geojson_options'],
  );
  $options['geojson_data'] = array(
    'default' => $getlocations_defaults['geojson_data'],
  );
  $options['zoomcontrolposition'] = array(
    'default' => $getlocations_defaults['zoomcontrolposition'],
  );
  $options['pancontrolposition'] = array(
    'default' => $getlocations_defaults['pancontrolposition'],
  );
  $options['mapcontrolposition'] = array(
    'default' => $getlocations_defaults['mapcontrolposition'],
  );
  $options['scalecontrolposition'] = array(
    'default' => $getlocations_defaults['scalecontrolposition'],
  );
  $options['svcontrolposition'] = array(
    'default' => $getlocations_defaults['svcontrolposition'],
  );
  $options['highlight_enable'] = array(
    'default' => $getlocations_defaults['highlight_enable'],
  );
  $options['highlight_strokecolor'] = array(
    'default' => $getlocations_defaults['highlight_strokecolor'],
  );
  $options['highlight_strokeopacity'] = array(
    'default' => $getlocations_defaults['highlight_strokeopacity'],
  );
  $options['highlight_strokeweight'] = array(
    'default' => $getlocations_defaults['highlight_strokeweight'],
  );
  $options['highlight_fillcolor'] = array(
    'default' => $getlocations_defaults['highlight_fillcolor'],
  );
  $options['highlight_fillopacity'] = array(
    'default' => $getlocations_defaults['highlight_fillopacity'],
  );
  $options['highlight_radius'] = array(
    'default' => $getlocations_defaults['highlight_radius'],
  );
  $options['getdirections_link'] = array(
    'default' => $getlocations_defaults['getdirections_link'],
  );
  $options['gps_button'] = array(
    'default' => 0,
  );
  $options['gps_button_label'] = array(
    'default' => $getlocations_defaults['gps_button_label'],
  );
  $options['gps_marker'] = array(
    'default' => $getlocations_defaults['gps_marker'],
  );
  $options['gps_marker_title'] = array(
    'default' => $getlocations_defaults['gps_marker_title'],
  );
  $options['gps_bubble'] = array(
    'default' => $getlocations_defaults['gps_bubble'],
  );
  $options['gps_geocode'] = array(
    'default' => $getlocations_defaults['gps_geocode'],
  );
  $options['gps_center'] = array(
    'default' => $getlocations_defaults['gps_center'],
  );
  $options['gps_type'] = array(
    'default' => $getlocations_defaults['gps_type'],
  );
  $options['gps_zoom'] = array(
    'default' => $getlocations_defaults['gps_zoom'],
  );
  $options['smartip_button'] = array(
    'default' => 0,
  );
  $options['smartip_button_label'] = array(
    'default' => $getlocations_defaults['smartip_button_label'],
  );
  $options['smartip_marker'] = array(
    'default' => $getlocations_defaults['smartip_marker'],
  );
  $options['smartip_marker_title'] = array(
    'default' => $getlocations_defaults['smartip_marker_title'],
  );
  $options['smartip_bubble'] = array(
    'default' => $getlocations_defaults['smartip_bubble'],
  );
  $options['smartip_center'] = array(
    'default' => $getlocations_defaults['smartip_center'],
  );
  $options['smartip_zoom'] = array(
    'default' => $getlocations_defaults['smartip_zoom'],
  );
  $options['smartip_callback'] = array(
    'default' => $getlocations_defaults['smartip_callback'],
  );
  $options['show_search_distance'] = array(
    'default' => $getlocations_defaults['show_search_distance'],
  );
  $options['views_search_marker_enable'] = array(
    'default' => $getlocations_defaults['views_search_marker_enable'],
  );
  $options['views_search_marker'] = array(
    'default' => $getlocations_defaults['views_search_marker'],
  );
  $options['views_search_marker_toggle'] = array(
    'default' => $getlocations_defaults['views_search_marker_toggle'],
  );
  $options['views_search_marker_toggle_active'] = array(
    'default' => $getlocations_defaults['views_search_marker_toggle_active'],
  );
  $options['views_search_radshape_enable'] = array(
    'default' => $getlocations_defaults['views_search_radshape_enable'],
  );
  $options['views_search_radshape_strokecolor'] = array(
    'default' => $getlocations_defaults['views_search_radshape_strokecolor'],
  );
  $options['views_search_radshape_strokeopacity'] = array(
    'default' => $getlocations_defaults['views_search_radshape_strokeopacity'],
  );
  $options['views_search_radshape_strokeweight'] = array(
    'default' => $getlocations_defaults['views_search_radshape_strokeweight'],
  );
  $options['views_search_radshape_fillcolor'] = array(
    'default' => $getlocations_defaults['views_search_radshape_fillcolor'],
  );
  $options['views_search_radshape_fillopacity'] = array(
    'default' => $getlocations_defaults['views_search_radshape_fillopacity'],
  );
  $options['views_search_radshape_toggle'] = array(
    'default' => $getlocations_defaults['views_search_radshape_toggle'],
  );
  $options['views_search_radshape_toggle_active'] = array(
    'default' => $getlocations_defaults['views_search_radshape_toggle_active'],
  );
  $options['views_search_center'] = array(
    'default' => $getlocations_defaults['views_search_center'],
  );

  // what3words
  $what3words_lic = variable_get('getlocations_what3words_lic', array(
    'key' => '',
    'url' => 'http://api.what3words.com',
  ));
  if ($what3words_lic['key']) {
    $options['what3words_key'] = array(
      'default' => $what3words_lic['key'],
    );
    $options['what3words_enable'] = array(
      'default' => $getlocations_defaults['what3words_enable'],
    );
    $options['what3words_search'] = array(
      'default' => $getlocations_defaults['what3words_search'],
    );
    $options['what3words_map_marker'] = array(
      'default' => $getlocations_defaults['what3words_map_marker'],
    );
    $options['what3words_center'] = array(
      'default' => $getlocations_defaults['what3words_center'],
    );
    $options['what3words_zoom'] = array(
      'default' => $getlocations_defaults['what3words_zoom'],
    );
    $options['what3words_show'] = array(
      'default' => $getlocations_defaults['what3words_show'],
    );
    $options['what3words_marker_show'] = array(
      'default' => $getlocations_defaults['what3words_marker_show'],
    );
    $options['what3words_click'] = array(
      'default' => $getlocations_defaults['what3words_click'],
    );
    $options['what3words_size'] = array(
      'default' => $getlocations_defaults['what3words_size'],
    );
  }

  // node markers
  $getlocations_node_marker = variable_get('getlocations_node_marker', array(
    'enable' => 0,
  ));
  if ($getlocations_node_marker['enable']) {
    if ($types = getlocations_get_types()) {
      foreach ($types as $type => $name) {
        $field_names = getlocations_get_fieldname2($type, 'node');
        foreach ($field_names as $field_name) {
          $mkey = 'node_marker__' . drupal_strtolower($type) . '__' . $field_name;
          $mmarker = isset($getlocations_node_marker['content_type'][$type]['field_name'][$field_name]['map_marker']) ? $getlocations_node_marker['content_type'][$type]['field_name'][$field_name]['map_marker'] : $getlocations_defaults['node_map_marker'];
          $options[$mkey] = array(
            'default' => $mmarker,
          );
        }
      }
    }
  }
  if (module_exists('taxonomy')) {

    // vocabulary markers
    if ($types = getlocations_get_vocabularies()) {
      $getlocations_vocabulary_marker = variable_get('getlocations_vocabulary_marker', array(
        'enable' => 0,
      ));
      if ($getlocations_vocabulary_marker['enable']) {
        foreach ($types as $type => $name) {
          $field_name = getlocations_get_fieldname($type, 'taxonomy_term');
          $mkey = 'vocabulary_marker_' . $field_name;
          $mmarker = isset($getlocations_vocabulary_marker['vocabulary'][$type]['map_marker']) ? $getlocations_vocabulary_marker['vocabulary'][$type]['map_marker'] : $getlocations_defaults['vocabulary_map_marker'];
          $options[$mkey] = array(
            'default' => $mmarker,
          );
        }
      }
    }

    // term markers
    $getlocations_term_marker = variable_get('getlocations_term_marker', array(
      'enable' => 0,
      'vids' => 0,
      'max_depth' => '',
    ));
    if ($getlocations_term_marker['enable'] && $getlocations_term_marker['vids']) {
      $depth = is_numeric($getlocations_term_marker['max_depth']) && $getlocations_term_marker['max_depth'] > 0 ? $getlocations_term_marker['max_depth'] : NULL;
      $vids = $getlocations_term_marker['vids'];
      foreach ($vids as $vid) {
        $terms = taxonomy_get_tree($vid, 0, $depth);
        foreach ($terms as $term) {
          $tid = $term->tid;
          $mkey = 'term_marker_' . $tid;
          $mmarker = isset($getlocations_term_marker['vid'][$vid]['term'][$tid]['map_marker']) ? $getlocations_term_marker['vid'][$vid]['term'][$tid]['map_marker'] : $getlocations_defaults['term_map_marker'];
          $options[$mkey] = array(
            'default' => $mmarker,
          );
        }
      }
    }
  }

  // empty_result
  $options['empty_result'] = array(
    'default' => FALSE,
  );
  return $options;
}