openlayers.render.inc in Openlayers 6.2

Processing functions for layers and behaviors

File

includes/openlayers.render.inc

<?php

/**
 * @file
 * Processing functions for layers and behaviors
 * @ingroup openlayers
 */

/**
 * Initialize the layer array into an indexed array of layer objects
 *
 * @param $layers
 *   Array of layers to process
 * @param $map
 *   Map array
 * @return $layer_data
 *   Array of initialized layer objects
 */
function _openlayers_layers_process($layers = array(), &$map = array()) {
  $layer_data = array();
  $weight = 0;
  foreach ($layers as $layer) {
    if ($layer_object = openlayers_layer_load($layer)) {
      $layer_object
        ->render($map);
      $layer_object->data['title'] = $layer_object->title;
      $layer_object->data['weight'] = ++$weight;
      $layer_data[$layer_object->name] = $layer_object->data;
    }
  }
  return $layer_data;
}

/**
 * Execute render() method for all enabled behaviors.
 *
 * @param $behaviors
 *   Array of behaviors to process
 * @param $map
 *   Map array
 * @return $rendered
 *  Indexed array of rendered behaviors
 */
function _openlayers_behaviors_render($behaviors = array(), &$map = array()) {
  $rendered = array();
  foreach (openlayers_behaviors() as $key => $plugin) {
    if (isset($behaviors[$key]) && ($class = ctools_plugin_get_class($plugin, 'behavior'))) {
      $behavior = new $class($behaviors[$key], $map);
      $rendered[$key] = $behavior
        ->render($map);
    }
  }
  return $rendered;
}

/**
 * Process Styles
 *
 * Get full data for any styles
 *
 * @param $styles
 *   Array of map styles ( <style_role> : <style_name> | <style_array> )
 * @param $layer_styles
 *   Array of layer styles ( <layer_name> : <style_name> | <by_role_array> )
 *   The <by_role_array> is an array of <style_name> indexed by <style_role>
 * @param $map
 *   Map array
 * @return $processed
 *   Indexed array of processed styles ( <style_name> => <style_array> )
 */
function _openlayers_styles_process($styles = array(), $layer_styles = array(), &$map = array()) {
  ctools_include('plugins');

  // Get styles info array
  $styles_info = openlayers_styles();

  // Process style property plugins, if any
  $used_plugins = array();
  foreach ($styles_info as $i => $style) {

    // Check for property plugins.
    foreach ($style->data as $prop => $propval) {
      if (is_array($propval)) {
        $plugname = $propval['plugin'];

        // This should never happen, except
        // for cases in which the old style plugin
        // system was used (for prop == 'plugins')
        if (empty($plugname)) {
          continue;
        }
        if (!isset($used_plugins[$plugname])) {

          // Lazily fetch list of style plugins
          if (!isset($style_plugins)) {
            $style_plugins = openlayers_style_plugins();
          }

          // Instanciate plugin class
          $ctplug = $style_plugins[$plugname];
          $plugin_class = ctools_plugin_get_class($ctplug, 'style_plugin');
          if (isset($plugin_class)) {
            $plugin = new $plugin_class();
            $used_plugins[$plugname] = array(
              'plugin' => $plugin,
              'methods' => $plugin
                ->get_context_properties(),
            );
          }
        }
        if (isset($used_plugins[$plugname])) {
          $method_name = $used_plugins[$plugname]['methods'][$prop];
          $style->data[$prop]['method'] = $method_name;
        }
        else {
          watchdog('openlayers', 'Could not find plugin "!plugname", ' . 'referenced by property "!prop" of style "!style"', array(
            '!plugname' => $plugname,
            '!prop' => $prop,
            '!style' => $i,
          ), WATCHDOG_WARNING);
          unset($style->data[$prop]);
        }
      }
    }
  }
  if (!empty($used_plugins)) {
    foreach ($used_plugins as $plugname => $plugin_info) {
      $plugin = $plugin_info['plugin'];
      $plugin
        ->render();
    }
  }

  // Go through styles
  $processed = array();
  foreach ($styles as $k => $style) {

    // Check if array, if array, just pass on
    if (is_array($style)) {
      $processed[$k] = $style;
    }
    elseif (!empty($styles_info[$style]) && ($info = $styles_info[$style]->data)) {
      $processed[$k] = $info;
    }
  }

  // Add layer styles
  foreach ($layer_styles as $stylename) {

    // UPGRADE NOTE:
    // Presets up to 6.x-2.x-alpha10 always had a single style
    // per layer specified. Newer ones have them splitted by role
    $stylenames = is_array($stylename) ? array_values($stylename) : array(
      $stylename,
    );
    foreach ($stylenames as $style) {
      if (!isset($processed[$style]) && !empty($styles_info[$style]) && ($info = $styles_info[$style]->data)) {
        $processed[$style] = $info;
      }
    }
  }

  // Run through theme function
  $processed = theme('openlayers_styles', $processed, $map);

  // Return processed
  return $processed;
}

/**
 * Create Map ID
 *
 * Create a unique ID for any maps that are not assigned an ID
 *
 * @note
 *   Technically someone can assign a map ID identical
 *   to the one that is created
 * @return
 *   New map id
 */
function _openlayers_create_map_id() {
  static $map_count = 0;
  $id = 'openlayers-map-auto-id-' . $map_count;
  $map_count++;
  return $id;
}

Related topics

OpenLayers provides an API and

Modules to interface with OpenLayers

Functions

Name	Description
_openlayers_behaviors_render	Execute render() method for all enabled behaviors.
_openlayers_create_map_id	Create Map ID
_openlayers_layers_process	Initialize the layer array into an indexed array of layer objects
_openlayers_styles_process	Process Styles