You are here

Home » API reference » Openlayers 7.2 » openlayers_views_style_data_image.inc

class openlayers_views_style_data_image in Openlayers 7.2

@class Extension of the Views Plugin Style for OpenLayers

This class extended the default views plugin class to provide a style plugin for the Open Layers module.

Hierarchy

Expanded class hierarchy of openlayers_views_style_data_image

1 string reference to 'openlayers_views_style_data_image'
openlayers_views_views_plugins in modules/openlayers_views/views/openlayers_views.views.inc
Implementation of hook_views_plugins().

File

modules/openlayers_views/views/openlayers_views_style_data_image.inc, line 17
This file holds style plugin for OpenLayers Views

View source 
class openlayers_views_style_data_image extends views_plugin_style {

  /**
   * Set default options
   *
   * Overrides views_plugin_style->option_definition
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['config'] = array();
    return $options;
  }

  /**
   * Render the map.
   *
   * Overrides views_plugin_style->render
   */
  function render() {
    $view = $this->view;

    // Render fields to trigger rewriting and other field processing.
    $this->view->style_plugin
      ->render_fields($this->view->result);
    $image_field = isset($this->options['config']['image_field']) ? $this->options['config']['image_field'] : NULL;
    $factor_x = !empty($this->options['config']['factors']['x']) ? $this->options['config']['factors']['x'] : 1;
    $factor_y = !empty($this->options['config']['factors']['y']) ? $this->options['config']['factors']['y'] : 1;
    $numzoomlevels = !empty($this->options['config']['numZoomLevels']) ? $this->options['config']['numZoomLevels'] : 1;
    $maxextent = !empty($this->options['config']['maxExtent']) ? $this->options['config']['maxExtent'] : NULL;
    foreach ($this->view->result as $count => $row) {
      if (isset($view->style_plugin->rendered_fields[$count][$image_field])) {
        $image = $view->style_plugin->rendered_fields[$count][$image_field];
        $value = $view->style_plugin
          ->get_field_value($count, $image_field);
        $field_output = array_shift($value);
        $data[] = array(
          'file' => $image,
          'size' => array(
            'w' => floatval($field_output['width']),
            'h' => floatval($field_output['height']),
          ),
          'factors' => array(
            'x' => floatval($factor_x),
            'y' => floatval($factor_y),
          ),
          'numZoomLevels' => floatval($numzoomlevels),
          'maxExtent' => $maxextent,
        );
      }
    }
    if (!empty($data)) {

      // Skip rendering if view is being edited or previewed.
      if (empty($this->view->live_preview)) {
        return $data[0];
      }
      else {
        return print_r($data[0], 1);
      }
    }
    else {
      return '';
    }
  }

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

    // Get list of fields in this view & flag available geodata fields
    $handlers = $this->display->handler
      ->get_handlers('field');

    // Check for any fields, as the view needs them
    if (empty($handlers)) {
      $form['error_markup'] = array(
        '#value' => t('You need to enable at least one field before you can ' . 'configure your field settings'),
        '#prefix' => '<div class="error form-item description">',
        '#suffix' => '</div>',
      );
      return;
    }
    $fields = array();
    foreach ($handlers as $field_id => $handler) {
      $fields[$field_id] = $handler
        ->ui_name();
    }
    $form['config'] = array(
      '#type' => 'fieldset',
      '#tree' => TRUE,
      '#title' => t('Image Source'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
    );
    $form['config']['image_field'] = array(
      '#type' => 'select',
      '#title' => t('Map Data Sources'),
      '#description' => t('Choose which sources of data that the map will ' . 'provide features for.'),
      '#options' => $fields,
      '#default_value' => $this->options['config']['image_field'],
    );
    $form['config']['factors'] = array(
      '#tree' => TRUE,
      'x' => array(
        '#title' => 'Width divider',
        '#type' => 'textfield',
        '#default_value' => isset($this->options['config']['factors']['x']) ? $this->options['config']['factors']['x'] : 1,
        '#description' => t('Width divider.'),
      ),
      'y' => array(
        '#title' => 'Height divider',
        '#type' => 'textfield',
        '#default_value' => isset($this->options['config']['factors']['y']) ? $this->options['config']['factors']['y'] : 1,
        '#description' => t('Height divider.'),
      ),
    );
    $form['config']['maxExtent'] = array(
      '#type' => 'textfield',
      '#title' => t('Max Extent'),
      '#default_value' => isset($this->options['config']['maxExtent']) ? implode(', ', $this->options['config']['maxExtent']) : '',
      '#description' => t('Should consist of four values (left, bottom, right, top). The maximum extent for the layer. Image is stretched to cover whole map if left empty.'),
    );
    $form['config']['numZoomLevels'] = array(
      '#title' => 'Zoomlevels',
      '#type' => 'textfield',
      '#default_value' => isset($this->options['config']['numZoomLevels']) ? $this->options['config']['numZoomLevels'] : 1,
    );
  }

}

Members

Namesort descending Modifiers Type Description Overrides
openlayers_views_style_data_image::options_form function Options form Overrides views_plugin_style::options_form
openlayers_views_style_data_image::option_definition function Set default options Overrides views_plugin_style::option_definition
openlayers_views_style_data_image::render function Render the 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::options_validate public function Validate the options form. Overrides views_plugin::options_validate
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