You are here

Home » API reference » Get Locations 7.2 » getlocations_mapquest_plugin_style.inc

class getlocations_mapquest_plugin_style in Get Locations 7.2

Same name and namespace in other branches
  1. 7 modules/getlocations_mapquest/views/getlocations_mapquest_plugin_style.inc \getlocations_mapquest_plugin_style

@file getlocations_mapquest_plugin_style.inc @author Bob Hutchinson http://drupal.org/user/52366 @copyright GNU GPL

Extension of the Views Plugin Style for Mapquest Map Adapted from the GeoField Map views module and the OpenLayers Views module.

Hierarchy

Expanded class hierarchy of getlocations_mapquest_plugin_style

1 string reference to 'getlocations_mapquest_plugin_style'
getlocations_mapquest_views_plugins in modules/getlocations_mapquest/views/getlocations_mapquest.views.inc
Define mapquest views style.

File

modules/getlocations_mapquest/views/getlocations_mapquest_plugin_style.inc, line 12
getlocations_mapquest_plugin_style.inc @author Bob Hutchinson http://drupal.org/user/52366 @copyright GNU GPL

View source 
class getlocations_mapquest_plugin_style extends views_plugin_style {

  /**
   * If this view is displaying an entity, save the entity type and info.
   */
  function init(&$view, &$display, $options = NULL) {
    parent::init($view, $display, $options);
    foreach (entity_get_info() as $key => $info) {
      if ($view->base_table == $info['base table']) {
        $this->entity_type = $key;
        $this->entity_info = $info;
        break;
      }
    }
  }

  /**
   * Set default options
   */
  function options(&$options) {
    parent::options($options);
    $options['empty_result'] = FALSE;
  }
  function option_definition() {
    $options = parent::option_definition();
    $getlocations_mapquest_defaults = getlocations_mapquest_defaults();

    // fallback
    $getlocations_defaults = getlocations_defaults();
    foreach ($getlocations_mapquest_defaults as $key => $value) {
      $options[$key] = array(
        'default' => $value,
      );
    }
    $options['map_resize'] = array(
      'default' => 0,
    );
    $options['fullscreen_disable'] = array(
      'default' => 0,
    );
    $options['styles'] = array(
      'default' => '',
    );
    $options['jquery_colorpicker_enabled'] = array(
      'default' => 0,
    );

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

  /**
   * Options form
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);

    #if (! module_exists('getlocations_fields')) {

    #  return;

    #}
    $form['#theme'] = 'getlocations_mapquest_plugin_style_options_form';
    $getlocations_mapquest_paths = getlocations_mapquest_paths_get();
    $getlocations_paths = getlocations_paths_get();
    $form['#attached']['js'] = array(
      $getlocations_mapquest_paths['getlocations_mapquest_formatter_path'],
      $getlocations_paths['getlocations_views_path'],
    );
    $handlers = $this->display->handler
      ->get_handlers('field');
    $source_options = array(
      '' => t('None'),
    );
    foreach ($handlers as $handle) {
      $source_options[$handle->options['id']] = !empty($handle->options['label']) ? $handle->options['label'] : $handle->options['id'];
    }
    $labels = array(
      'width' => t('Width'),
      'height' => t('Height'),
    );
    $form += getlocations_map_display_basics_form($this->options, $labels);
    unset($form['map_resize']);
    unset($form['fullscreen_disable']);
    unset($form['styles']);
    unset($form['zoom']['#options']['21']);
    unset($form['zoom']['#options']['20']);
    unset($form['zoom']['#options']['19']);
    unset($form['minzoom_map']['#options']['21']);
    unset($form['minzoom_map']['#options']['20']);
    unset($form['minzoom_map']['#options']['19']);
    unset($form['maxzoom_map']['#options']['21']);
    unset($form['maxzoom_map']['#options']['20']);
    unset($form['maxzoom_map']['#options']['19']);
    $form += getlocations_mapquest_display_options_form($this->options);
    unset($form['nodezoom']['#options']['21']);
    unset($form['nodezoom']['#options']['20']);
    unset($form['nodezoom']['#options']['19']);

    // markers
    $markers = getlocations_get_marker_titles();
    $getlocations_markers = variable_get('getlocations_markers', array());
    $type_markers = getlocations_get_type_markers();
    $per_field_markers = FALSE;
    foreach ($type_markers as $entity_type => $bundles) {
      if (isset($getlocations_markers[$entity_type]['enable']) && $getlocations_markers[$entity_type]['enable']) {
        $per_field_markers = TRUE;
        $entity_get_info = entity_get_info($entity_type);
        $entity_type_label = $entity_get_info['label'];
        foreach ($bundles as $bundle => $field_names) {
          foreach ($field_names as $field_name => $marker_data) {
            $bundle_label = $marker_data['bundle_label'];
            $mkey = 'marker__' . $entity_type . '__' . $bundle . '__' . $field_name;
            if (!isset($this->options[$mkey])) {
              $this->options[$mkey] = isset($getlocations_markers[$entity_type][$bundle][$field_name]['marker']) ? $getlocations_markers[$entity_type][$bundle][$field_name]['marker'] : (isset($getlocations_defaults[$entity_type . '_map_marker']) ? $this->options[$entity_type . '_map_marker'] : $this->options['map_marker']);
            }
            $form[$mkey] = getlocations_element_map_marker(t('Type %etl, Bundle %name, Field %field Map marker', array(
              '%etl' => $entity_type_label,
              '%name' => $bundle_label,
              '%field' => $field_name,
            )), $markers, $this->options[$mkey]);
          }
        }
      }
    }
    if (!$per_field_markers) {

      // markers
      foreach ($fieldables as $entity_type) {
        $entity_get_info = entity_get_info($entity_type);
        $label = $entity_get_info['label'];
        $desc = '';
        if (getlocations_check_entity_type($entity_type)) {
          $form[$entity_type . '_map_marker'] = getlocations_element_map_marker(t('Default !label Map marker', array(
            '!label' => $label,
          )), $markers, $this->options[$entity_type . '_map_marker'], $desc);
        }
      }
    }

    // search markers
    if (module_exists('getlocations_fields') && module_exists('views')) {
      $form += getlocations_fields_views_search_form($this->options, 'mapquest');
    }

    // end markers
    // categories
    $term_reference_fields = getlocations_get_term_reference_fields();
    $opts = array(
      0 => t('None'),
      1 => t('Content Type'),
    );
    if ($term_reference_fields) {
      $opts += array(
        2 => t('Term reference'),
      );
    }
    $form['category_method'] = getlocations_element_dd(t('Category method'), $this->options['category_method'], $opts, t('To ensure that this works you will need to add either a Content type or a Term reference field to the Field list in your View.'));
    $form['category_method']['#suffix'] = '<div id="wrap-category1">';
    if ($term_reference_fields) {
      $form['category_term_reference_field'] = getlocations_element_dd(t('Term reference field name'), $this->options['category_term_reference_field'], $term_reference_fields, t('Select the field on which you are categorising.'));
      $form['category_term_reference_field']['#prefix'] = '<div id="wrap-category2">';
      $form['category_term_reference_field']['#suffix'] = '</div>';
    }
    $form['category_showhide_buttons'] = getlocations_element_map_checkbox(t('Enable category show/hide buttons'), $this->options['category_showhide_buttons'], t('This option will place toggle buttons on the map.'));
    $form['category_showhide_buttons']['#suffix'] = '</div>';

    // custom content
    $form['custom_content_enable'] = getlocations_element_map_checkbox(t('Replace default content'), $this->options['custom_content_enable']);
    $form['custom_content_enable']['#prefix'] = '<div id="wrap-custom-content-enable">';
    $form['custom_content_enable']['#suffix'] = '</div>';
    $form['custom_content_source'] = getlocations_element_dd(t('Popup Data'), $this->options['custom_content_source'], $source_options, t('The field to use as a data source for the marker popup.'));
    $form['custom_content_source']['#prefix'] = '<div id="wrap-custom-content-source">';
    $form['custom_content_source']['#suffix'] = '</div>';
    $form['empty_result'] = getlocations_element_map_checkbox(t('Show map even if view has no results'), $this->options['empty_result']);

    // munge the title and description
    $form['category_showhide_buttons']['#title'] = t('Enable category show/hide checkboxes');
    $form['category_showhide_buttons']['#description'] = t('This option will place checkboxes on the layer control');
  }

  // end options_form

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

    // css check
    if (isset($form_state['values']['style_options']['width'])) {
      if ($check = getlocations_dim_check($form_state['values']['style_options']['width'])) {
        $form_state['values']['style_options']['width'] = $check;
      }
      else {
        form_set_error('style_options][width', t('Width must be valid css'));
      }
    }
    if (isset($form_state['values']['style_options']['height'])) {
      if ($check = getlocations_dim_check($form_state['values']['style_options']['height'])) {
        $form_state['values']['style_options']['height'] = $check;
      }
      else {
        form_set_error('style_options][height', t('Height must be valid css'));
      }
    }

    // latlong
    if (isset($form_state['values']['style_options']['latlong'])) {
      if ($latlon = getlocations_latlon_check($form_state['values']['style_options']['latlong'])) {
        $form_state['values']['style_options']['latlong'] = $latlon;
      }
      else {
        form_set_error('style_options][latlong', t('Map coordinates must be expressed as a decimal latitude and longitude, separated by a comma.'));
      }
    }
  }
  function even_empty() {
    return parent::even_empty() || !empty($this->options['empty_result']);
  }
  function render() {
    if (isset($this->view->live_preview) && $this->view->live_preview) {
      return t('Getlocations Mapquest views are not compatible with live preview.');
    }
    return parent::render();
  }

}

Members

Namesort descending Modifiers Type Description Overrides
getlocations_mapquest_plugin_style::even_empty function Should the output of the style plugin be rendered even if it's empty. Overrides views_plugin_style::even_empty
getlocations_mapquest_plugin_style::init function If this view is displaying an entity, save the entity type and info. Overrides views_plugin_style::init
getlocations_mapquest_plugin_style::options function Set default options Overrides views_object::options
getlocations_mapquest_plugin_style::options_form function Options form Overrides views_plugin_style::options_form
getlocations_mapquest_plugin_style::options_validate function Validate the options form. Overrides views_plugin_style::options_validate
getlocations_mapquest_plugin_style::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_plugin_style::option_definition
getlocations_mapquest_plugin_style::render function Render the display in this style. 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::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::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::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