You are here

Home » API reference » KML 7 » views_plugin_style_kml.inc

class views_plugin_style_kml in KML 7

Same name and namespace in other branches
  1. 6.2 views/views_plugin_style_kml.inc \views_plugin_style_kml

@file Extending the view_plugin_style class to provide a kml view style.

Hierarchy

Expanded class hierarchy of views_plugin_style_kml

1 string reference to 'views_plugin_style_kml'
kml_views_plugins in views/kml.views.inc
Implements hook_views_style_plugins(). Adds view types to views UI interface.

File

views/views_plugin_style_kml.inc, line 7
Extending the view_plugin_style class to provide a kml view style.

View source 
class views_plugin_style_kml extends views_plugin_style {

  /**
   * Initialize plugin.
   *
   * Set feed image for shared rendering later.
   */
  function init(&$view, &$display, $options = NULL) {
    parent::init($view, $display, $options = NULL);
    $this->feed_image = drupal_get_path('module', 'kml') . '/images/kml.png';
  }

  /**
   * Attach this view to another display as a feed.
   *
   * Provide basic functionality for all export style views like attaching a
   * feed image link.
   */
  function attach_to($display_id, $path, $title) {
    $url_options = array(
      'html' => TRUE,
    );

    // Include exposed filters
    $query = $this->view
      ->get_exposed_input();
    if ($query) {
      $url_options['query'] = $query;
    }
    $image = theme('image', array(
      'path' => $this->feed_image,
    ));
    $this->view->feed_icon .= l($image, $this->view
      ->get_url(NULL, $path), $url_options);
  }
  function option_definition() {
    $options = parent::option_definition();
    $field_options = array(
      'name' => t('Name'),
      'description' => t('Description'),
      'longitude' => t('Longitude'),
      'latitude' => t('Latitude'),
    );
    foreach ($field_options as $k => $v) {
      $fields[$k] = array(
        'default' => '',
      );
    }
    $options['fields'] = array(
      'contains' => $fields,
    );
    $options['filename'] = array(
      'default' => isset($this->filename) ? $this->filename : '',
      'translatable' => FALSE,
    );
    return $options;
  }

  /**
   * Provide a form for setting options.
   *
   * @param array $form
   * @param array $form_state
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $options = parent::option_definition();
    $handlers = $this->display->handler
      ->get_handlers('field');
    if (empty($handlers)) {
      $form['error_markup'] = array(
        '#value' => t('You need at least one field before you can
        configure your field settings'),
        '#prefix' => '<div class="error form-item description">',
        '#suffix' => '</div>',
      );
    }
    else {
      foreach ($handlers as $field => $handler) {
        if ($label = $handler
          ->label()) {
          $field_names[$field] = $label;
        }
        else {
          $field_names[$field] = $handler
            ->ui_name();
        }
      }
      $field_options = array(
        'name' => t('Name'),
        'description' => t('Description'),
        'longitude' => t('Longitude'),
        'latitude' => t('Latitude'),
      );
      $form['filename'] = array(
        '#type' => 'textfield',
        '#title' => t('Filename'),
        '#default_value' => $this->options['filename'],
        '#description' => t('The filename that will be suggested to the browser
        for downloading purposes. Leave empty to use the view title. ".kml"
        will be automatically appended.'),
      );
      $form['fields'] = array(
        '#type' => 'fieldset',
        '#title' => 'Field usage',
        '#description' => t('Select the fields that contain the latitude,
        longitude and title of each point.
        Remaining fields will be available in the
        "content" region of the point.'),
        '#weight' => -10,
      );
      foreach ($field_options as $k => $v) {
        $form['fields'][$k] = array(
          '#type' => 'select',
          '#title' => $v,
          '#options' => $field_names,
          '#default_value' => $this->options['fields'][$k],
          '#required' => $k == 'class' ? FALSE : TRUE,
        );
      }
    }
  }
  function map_rows($rows) {

    // Fields must be rendered in order as of Views 2.3,
    // so we will pre-render everything.
    $renders = array();
    $keys = array_keys($this->view->field);
    $renders = $this
      ->render_fields($rows);
    $points = array();
    foreach ($renders as $id => $row) {
      $point = array();
      foreach ($this->view->field as $key => $field) {
        if ($key == $this->options['fields']['name']) {
          $point['name'] = $row[$key];
        }
        elseif ($key == $this->options['fields']['description']) {
          $point['description'] = $row[$key];
        }
        elseif ($key == $this->options['fields']['longitude']) {
          $point['lon'] = $row[$key];
        }
        elseif ($key == $this->options['fields']['latitude']) {
          $point['lat'] = $row[$key];
        }
      }
      $point['point'] = $point['lon'] . ',' . $point['lat'] . ',0';
      unset($point['lat']);
      unset($point['lon']);
      if (isset($this->options['linestring']) && $this->options['linestring']['enable']) {
        $points[$point['group']][] = $point;
      }
      else {
        $points[] = $point;
      }
    }
    return $points;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
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::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 public function Render the display in this style. 5
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
views_plugin_style_kml::attach_to function Attach this view to another display as a feed.
views_plugin_style_kml::init function Initialize plugin. Overrides views_plugin_style::init
views_plugin_style_kml::map_rows function
views_plugin_style_kml::options_form function Provide a form for setting options. Overrides views_plugin_style::options_form
views_plugin_style_kml::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_plugin_style::option_definition