You are here

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

class getlocations_fields_plugin_style_streetview in Get Locations 7.2

Same name and namespace in other branches
  1. 7 modules/getlocations_fields/views/getlocations_fields_plugin_style_streetview.inc \getlocations_fields_plugin_style_streetview

Getlocations style plugin to render a row as a google streetview.

Hierarchy

Expanded class hierarchy of getlocations_fields_plugin_style_streetview

1 string reference to 'getlocations_fields_plugin_style_streetview'
getlocations_fields_views_plugins in modules/getlocations_fields/views/getlocations_fields.views.inc
Implements hook_views_plugins().

File

modules/getlocations_fields/views/getlocations_fields_plugin_style_streetview.inc, line 17
getlocations_fields_plugin_style_streetview.inc @author Bob Hutchinson http://drupal.org/user/52366 @copyright GNU GPL

View source 
class getlocations_fields_plugin_style_streetview 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_defaults = getlocations_defaults();
    $options['width'] = array(
      'default' => $getlocations_defaults['width'],
    );
    $options['height'] = array(
      'default' => $getlocations_defaults['height'],
    );
    $options['sv_addresscontrol'] = array(
      'default' => 1,
    );
    $options['sv_addresscontrolposition'] = array(
      'default' => '',
    );
    $options['sv_pancontrol'] = array(
      'default' => 1,
    );
    $options['sv_pancontrolposition'] = array(
      'default' => '',
    );
    $options['sv_zoomcontrol'] = array(
      'default' => 'default',
    );
    $options['sv_zoomcontrolposition'] = array(
      'default' => '',
    );
    $options['sv_linkscontrol'] = array(
      'default' => 1,
    );
    $options['sv_imagedatecontrol'] = array(
      'default' => 0,
    );
    $options['sv_scrollwheel'] = array(
      'default' => 1,
    );
    $options['sv_clicktogo'] = array(
      'default' => 1,
    );
    $options['sv_fullscreen'] = array(
      'default' => 0,
    );
    return $options;
  }

  // end option_definition
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    if (!module_exists('getlocations_fields')) {
      return;
    }
    $form['#theme'] = 'getlocations_plugin_style_streetview_options_form';
    $getlocations_fields_paths = getlocations_fields_paths_get();
    $form['#attached']['js'] = array(
      $getlocations_fields_paths['getlocations_fields_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'];
    }

    // streetview killswitch
    if (!getlocations_fields_streetview_settings_allow()) {
      $form['message'] = array(
        '#markup' => '<p><b>' . t('Streetview has been disabled globally, this plugin is inactive.') . '</b></p>',
      );
    }
    $form['width'] = getlocations_element_map_tf(t('Width'), $this->options['width'], t('The default width of a Google streetview, as a CSS length or percentage. Examples: <em>50px</em>, <em>5em</em>, <em>2.5in</em>, <em>95%</em>'), 10, 10, TRUE);
    $form['height'] = getlocations_element_map_tf(t('Height'), $this->options['height'], t('The default height of a Google streetview, as a CSS length or percentage. Examples: <em>50px</em>, <em>5em</em>, <em>2.5in</em>, <em>95%</em>'), 10, 10, TRUE);
    $form += getlocations_fields_sv_control_form($this->options);
    $form['sv_fullscreen'] = getlocations_element_map_checkbox(t('Show Fullscreen button'), $this->options['sv_fullscreen']);
  }

  // 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'));
      }
    }
  }
  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 Streetview views are not compatible with live preview.');
    }
    return parent::render();
  }

}

Members

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