class openlayers_views_style_data in Openlayers 7.2

Same name and namespace in other branches

6.2 modules/openlayers_views/views/openlayers_views_style_data.inc \openlayers_views_style_data

@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

class \views_object
- class \views_plugin
  - class \views_plugin_style
    class \openlayers_views_style_data

Expanded class hierarchy of openlayers_views_style_data

1 string reference to 'openlayers_views_style_data'

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.inc, line 17: This file holds style plugin for OpenLayers Views

View source

class openlayers_views_style_data extends views_plugin_style {

  /**
   * Render the map features.
   *
   * Overrides views_plugin_style->render
   */
  function render() {
    $grouped_results = $this
      ->render_grouping($this->view->result, $this->options['grouping']);
    $data = $this
      ->map_features($grouped_results);

    // If we are not in preview, just return the data
    if (empty($this->view->live_preview)) {
      return $data;
    }
    else {

      // If we are in preview mode, dump out some useful information about this data layer
      $output = "You can use the following parameters in your styles as dynamic values";
      $output .= "\n------------\n";
      if (!empty($data)) {
        $keys = array_keys($data);
        foreach ($data[$keys[0]]['attributes'] as $key => $value) {
          $output .= '${' . $key . "}\n";
        }
      }
      $output .= "\n------------\n";
      $output .= t('The following is a dump of the data that is rendered from this display. It is used for debugging purposes only.') . '
        ' . var_export($data, TRUE);
      return $output;
    }
  }

  /**
   * Set default options
   *
   * Overrides views_plugin_style->option_definition
   */
  function option_definition() {
    $options = parent::option_definition();
    $options['data_source'] = array(
      'projection' => 'EPSG:4326',
      'default' => 'openlayers_wkt',
    );
    $options['attributes'] = array(
      'default' => array(),
    );
    return $options;
  }

  /**
   * 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() . ' (' . $field_id . ')';
    }
    $projections = array();
    foreach (openlayers_get_all_projections() as $projection) {
      $projections[$projection->identifier] = $projection
        ->getLocalizedMessage();
    }
    $form['data_source'] = array(
      '#type' => 'fieldset',
      '#tree' => TRUE,
      '#title' => t('Data Source'),
      '#collapsible' => TRUE,
      '#collapsed' => FALSE,
    );
    $form['data_source']['value'] = array(
      '#type' => 'select',
      '#title' => t('Map Data Sources'),
      '#description' => t('Choose which sources of data that the map will ' . 'provide features for.'),
      '#options' => array(
        'other_latlon' => t('Lat/Lon Pair'),
        'other_boundingbox' => t('Bounding Box'),
        'wkt' => t('WKT'),
      ),
      '#default_value' => $this->options['data_source']['value'],
    );
    if (count($fields > 0)) {
      $form['data_source']['other_lat'] = array(
        '#type' => 'select',
        '#title' => t('Latitude Field'),
        '#description' => t('Choose a field for Latitude.  This should be a ' . 'field that is a decimal or float value.'),
        '#options' => $fields,
        '#default_value' => $this->options['data_source']['other_lat'],
        '#states' => $this
          ->datasource_dependent('other_latlon'),
      );
      $form['data_source']['other_lon'] = array(
        '#type' => 'select',
        '#title' => t('Longitude Field'),
        '#description' => t('Choose a field for Longitude.  This should be a ' . 'field that is a decimal or float value.'),
        '#options' => $fields,
        '#default_value' => $this->options['data_source']['other_lon'],
        '#states' => $this
          ->datasource_dependent('other_latlon'),
      );
      $form['data_source']['wkt'] = array(
        '#type' => 'select',
        '#title' => t('WKT Field'),
        '#description' => t('Choose the OpenLayers WKT field.'),
        '#options' => $fields,
        '#default_value' => $this->options['data_source']['wkt'],
        '#states' => $this
          ->datasource_dependent('wkt'),
      );
      $form['data_source']['projection'] = array(
        '#type' => 'select',
        '#title' => t('Projection'),
        '#description' => t('Choose the projection of the WKT field.'),
        '#options' => $projections,
        '#default_value' => $this->options['data_source']['projection'],
        '#states' => $this
          ->datasource_dependent('wkt'),
      );
      $form['data_source']['other_top'] = array(
        '#type' => 'select',
        '#title' => t('Top Field'),
        '#description' => t('Choose a field for Top.  This should be a ' . 'field that is a decimal or float value.'),
        '#options' => $fields,
        '#default_value' => $this->options['data_source']['other_top'],
        '#states' => $this
          ->datasource_dependent('other_boundingbox'),
      );
      $form['data_source']['other_right'] = array(
        '#type' => 'select',
        '#title' => t('Right Field'),
        '#description' => t('Choose a field for Right.  This should be a field ' . 'that is a decimal or float value.'),
        '#options' => $fields,
        '#default_value' => $this->options['data_source']['other_right'],
        '#states' => $this
          ->datasource_dependent('other_boundingbox'),
      );
      $form['data_source']['other_bottom'] = array(
        '#type' => 'select',
        '#title' => t('Bottom Field'),
        '#description' => t('Choose a field for Bottom.  This should be a ' . 'field that is a decimal or float value.'),
        '#options' => $fields,
        '#default_value' => $this->options['data_source']['other_bottom'],
        '#states' => $this
          ->datasource_dependent('other_boundingbox'),
      );
      $form['data_source']['other_left'] = array(
        '#type' => 'select',
        '#title' => t('Left Field'),
        '#description' => t('Choose a field for Left.  This should be a field ' . 'that is a decimal or float value.'),
        '#options' => $fields,
        '#default_value' => $this->options['data_source']['other_left'],
        '#states' => $this
          ->datasource_dependent('other_boundingbox'),
      );
    }
    $form['data_source']['name_field'] = array(
      '#type' => 'select',
      '#title' => t('Title Field'),
      '#description' => t('Choose the field which will appear as a title on ' . 'tooltips.'),
      '#options' => array_merge(array(
        '' => '',
      ), $fields),
      '#default_value' => $this->options['data_source']['name_field'],
    );
    $desc_options = array_merge(array(
      '' => '',
      '#row' => '<' . t('entire row') . '>',
    ), $fields);

    // Description field
    $form['data_source']['description_field'] = array(
      '#type' => 'select',
      '#title' => t('Description Content'),
      '#description' => t('Choose the field or rendering method which will
        appear as a description on tooltips or popups.'),
      '#required' => FALSE,
      '#options' => $desc_options,
      '#default_value' => $this->options['data_source']['description_field'],
    );

    // A simple way to display attributes and styling
    $form['attributes'] = array(
      '#type' => 'fieldset',
      '#title' => t('Attributes and Styling'),
      '#description' => t('Attributes are field data attached to each ' . 'feature.  This can be used with styling to create Variable styling.'),
      '#collapsible' => TRUE,
      '#collapsed' => TRUE,
    );
    $variable_fields = array();
    foreach ($this->view->display_handler
      ->get_handlers('field') as $field => $handler) {
      $variable_fields[$field] = '${' . $field . '}';
    }
    if (!empty($this->options['data_source']['name_field'])) {
      $variable_fields['name'] = '${name}';
    }
    if (!empty($this->options['data_source']['description_field'])) {
      $variable_fields['description'] = '${description}';
    }
    $form['attributes']['display'] = array(
      '#title' => 'Select attributes to include in the features',
      '#type' => 'checkboxes',
      '#options' => $variable_fields,
      '#default_value' => !empty($this->options['attributes']['display']) ? $this->options['attributes']['display'] : array_combine(array_keys($variable_fields), array_keys($variable_fields)),
      '#description' => t('Any fields that you select will be attached to ' . 'their respective feature (point, line, polygon) as attributes.  ' . 'These attributes can then be used to add variable styling to your ' . 'themes.  This is accomplished by using the %syntax syntax in the ' . 'values for a style.  You can see a list of available variables in ' . 'the view preview; these can be placed right in the style interface. ' . 'The field has been processed by Views.' . 'By disabling some of them, you can reduce the size ' . 'of the Javascript included in your pages.' . 'Please note that this does not apply to Grouped Displays.', array(
        '%syntax' => '${field_name}',
      )),
    );
  }

  /**
   * @param $records ...
   *
   * openlayers_views_style_data specific
   */
  function map_features($sets = array()) {
    $features = $excluded_fields = array();
    $handlers = $this->display->handler
      ->get_handlers('field');
    foreach ($sets as $title => $records) {
      foreach ($records as $id => $record) {
        $this->view->row_index = $id;
        $attributes = array();
        $wkt = NULL;
        $field_exclude = array();

        // Save the 'exclude' options of fields as backup.
        foreach ($this->view->field as $fid => $field) {
          $field_exclude[$fid] = $field->options['exclude'];
        }

        // Loop through each fields and render it if there were only one
        // field in the row, so we have all the goodness of Views's field
        // wrapping, class customizations and label.
        foreach ($handlers as $hid => $handler) {
          $field_id = $handler->options['id'];

          // Exclude all the field from rendering
          foreach ($this->view->field as $field) {
            $field->options['exclude'] = TRUE;
          }

          // Enable only the field we want to render the row.
          $this->view->field[$field_id]->options['exclude'] = FALSE;

          // Render the row.
          $attributes[$hid] = trim($this->row_plugin
            ->render($record));
        }

        // Restore the state of the exclude options in the fields.
        foreach ($this->view->field as $fid => $field) {
          $this->view->field[$fid]->options['exclude'] = $field_exclude[$fid];
        }

        // Add the 'name' attribute.
        if (isset($this->options['data_source']['name_field'])) {
          if (isset($attributes[$this->options['data_source']['name_field']])) {
            $attributes['name'] = $attributes[$this->options['data_source']['name_field']];
          }
        }

        // Add the 'description' attribute.
        if (isset($this->options['data_source']['description_field'])) {

          // Handle rendering the whole record.
          if ($this->options['data_source']['description_field'] === '#row') {
            $attributes['description'] = trim($this->row_plugin
              ->render($record));
          }
          else {
            if (isset($attributes[$this->options['data_source']['description_field']])) {
              $attributes['description'] = $attributes[$this->options['data_source']['description_field']];
            }
          }
        }

        // We do not need the rendered value for these fields,
        // just the raw value.
        // This is why we use $this->rendered_fields.
        if (isset($this->options['data_source']['value'])) {
          switch ($this->options['data_source']['value']) {
            case 'wkt':
              $handler = $handlers[$this->options['data_source']['wkt']];
              $wkt = $handler
                ->allow_advanced_render() ? $handler
                ->advanced_render($record) : $handler
                ->render($record);
              break;
            case 'other_latlon':
              $handler = $handlers[$this->options['data_source']['other_lon']];
              $other_lon = $handler
                ->allow_advanced_render() ? $handler
                ->advanced_render($record) : $handler
                ->render($record);
              $handler = $handlers[$this->options['data_source']['other_lat']];
              $other_lat = $handler
                ->allow_advanced_render() ? $handler
                ->advanced_render($record) : $handler
                ->render($record);
              $wkt = 'POINT(' . $other_lon . ' ' . $other_lat . ')';
              break;
          }
        }

        // Only render features that has been enabled in the configuration
        // of the display.
        if (isset($this->options['attributes']['display'])) {
          foreach ($this->options['attributes']['display'] as $fid => $value) {
            if ($this->options['attributes']['display'][$fid] === 0) {
              unset($attributes[$fid]);
            }
          }
        }

        // Create features array.
        $feature = array(
          'projection' => $this->options['data_source']['projection'],
          'attributes' => $attributes,
          'wkt' => $wkt,
        );
        $features = $this
          ->reduce_features($this->options['grouping'], $features, $feature, $title);
      }
    }

    // For grouping, handle a bit differently.
    if ($this->options['grouping']) {
      $features = $this
        ->coalesce_groups($features, $handlers, $this->options['data_source']);
    }
    return $features;
  }

  /**
   * Basically a macro because
   * #state is rather verbose
   *
   * openlayers_views_style_data specific
   */
  function datasource_dependent($type) {
    return array(
      'visible' => array(
        '#edit-style-options-data-source-value' => array(
          'value' => $type,
        ),
      ),
    );
  }

  /**
   * Coalesce features into single grouped feature when grouping is enabled.
   *
   * openlayers_views_style_data specific
   */
  function coalesce_groups($features, $handlers, $ds) {

    // Combine wkt into geometry collections if they are an array
    foreach ($features as &$feature) {
      if (is_array($feature['wkt'])) {
        if (count($feature['wkt']) > 1) {
          $feature['wkt'] = $this
            ->get_group_wkt($feature['wkt']);
        }
        else {
          $feature['wkt'] = $feature['wkt'][0];
        }
      }
    }

    // Process title and description for groups
    foreach ($features as $k => &$feature) {
      $feature['attributes']['name'] = $k;
      $feature['attributes'] = array_merge($feature['attributes'], $feature['features'][0]['attributes']);
      $formatted_features = array();
      foreach ($feature['features'] as $subfeature) {

        // Create name and description attributes.  Note that there are a
        // couple exceptions to using fields.
        $exceptions = array(
          '#row',
        );

        // Run the output through a theme.
        $formatted_features[] = theme('openlayers_views_group_display_item', array(
          'name' => isset($handlers[$ds['name_field']]) ? $subfeature['attributes'][$ds['name_field']] : FALSE,
          'description' => in_array($ds['description_field'], $exceptions) || isset($handlers[$ds['description_field']]) ? $subfeature['attributes'][$ds['description_field']] : FALSE,
        ));

        // Remove rendered rows to keep data size down for JS.
        if (in_array($ds['description_field'], $exceptions)) {
          unset($subfeature['attributes'][$ds['description_field']]);
        }
      }

      // Then run all gathered features through item_ist theme.
      $feature['attributes']['description'] = theme('item_list', array(
        'items' => $formatted_features,
      ));
    }
    return $features;
  }

  /**
   * Combine all group wkt into a single geometry collection
   *
   * openlayers_views_style_data specific
   */
  function get_group_wkt($wkt_array) {
    geophp_load();
    $geophp = geoPHP::load($wkt_array, 'wkt');
    if (!empty($geoPHP)) {
      return $geophp
        ->out('wkt');
    }
    return array();
  }

  /**
   * Split string according to first match of passed regEx index of $regExes
   */
  function preg_explode($regEx, $str) {
    $matches = array();
    preg_match($this->regExes[$regEx], $str, $matches);
    return empty($matches) ? array(
      trim($str),
    ) : explode($matches[0], trim($str));
  }

  /**
   * Basically an algebraic reduction; given whether to group,
   * a feature, a list of features, etc., return a full $features
   * array with the element added, either straight non-grouped,
   * or within a new or existing group
   *
   * openlayers_views_style_data specific
   */
  function reduce_features($is_grouped, $features, $feature, $group) {
    if ($is_grouped) {
      if (isset($features[$group])) {
        $features[$group]['attributes']['count']++;
        $features[$group]['wkt'][] = $feature['wkt'];
        $features[$group]['features'][] = $feature;
        return $features;
      }
      else {
        $features[$group] = array(
          'attributes' => array(
            'count' => 1,
          ),
          'wkt' => array(
            $feature['wkt'],
          ),
          'projection' => $feature['projection'],
          'features' => array(
            $feature,
          ),
        );
        return $features;
      }
    }
    else {
      array_push($features, $feature);
      return $features;
    }
  }

}

Members

Name	Modifiers	Type	Description	Overrides
openlayers_views_style_data::coalesce_groups		function	Coalesce features into single grouped feature when grouping is enabled.
openlayers_views_style_data::datasource_dependent		function	Basically a macro because #state is rather verbose
openlayers_views_style_data::get_group_wkt		function	Combine all group wkt into a single geometry collection
openlayers_views_style_data::map_features		function
openlayers_views_style_data::options_form		function	Options form Overrides views_plugin_style::options_form
openlayers_views_style_data::option_definition		function	Set default options Overrides views_plugin_style::option_definition
openlayers_views_style_data::preg_explode		function	Split string according to first match of passed regEx index of $regExes
openlayers_views_style_data::reduce_features		function	Basically an algebraic reduction; given whether to group, a feature, a list of features, etc., return a full $features array with the element added, either straight non-grouped, or within a new or existing group
openlayers_views_style_data::render		function	Render the map features. 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

You are here

class openlayers_views_style_data in Openlayers 7.2

Hierarchy

File

Members

API Navigation