You are here

views_calc_field_handler.inc in Views Calc 7

Same filename and directory in other branches
  1. 6.3 views_calc_field_handler.inc
  2. 6 views_calc_field_handler.inc

Copied from the basic 'node' field handler.

File

views_calc_field_handler.inc
View source
<?php

/**
 * @file
 * Copied from the basic 'node' field handler.
 */

/**
 * Field handler to provide simple renderer that allows linking to a node.
 */
class views_calc_field_handler extends views_handler_field {

  /**
   * Constructor to provide additional field to add.
   */
  function construct() {
    parent::construct();
    $this->additional_fields['nid'] = 'nid';
  }
  function option_definition() {
    $options = parent::option_definition();
    $options['link_to_node'] = array(
      'default' => FALSE,
    );
    return $options;
  }

  /**
   * Provide link to node option
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['link_to_node'] = array(
      '#title' => t('Link this field to its node'),
      '#type' => 'checkbox',
      '#default_value' => !empty($this->options['link_to_node']),
    );
  }

  /**
   * Render whatever the data is as a link to the node.
   *
   * Data should be made XSS safe prior to calling this function.
   */
  function render_link($data, $values) {
    if (!empty($this->options['link_to_node'])) {
      return l($data, "node/" . $values->{$this->aliases['nid']}, array(
        'html' => TRUE,
      ));
    }
    else {
      return $data;
    }
  }

  /**
   * Find the right calculation and add it to the query as
   * an aliased field.
   */
  function query() {
    $results = _views_calc_fields();
    foreach ($results as $calc_field) {
      if ($this->definition['cid'] == $calc_field->cid) {

        // Ensure that the expected tables and fields have been joined in.
        foreach (explode(',', $calc_field->fieldlist) as $field) {
          $parts = explode('.', $field);

          //$this->view->query->add_field($parts[0], $parts[1]);
          $this->view->query
            ->add_table($parts[0]);
        }
        $this->view->query
          ->add_field(NULL, "({$calc_field->calc})", "cid" . $calc_field->cid);
      }
    }
  }
  function pre_query() {
    $this->field_alias = "cid{$this->definition['cid']}";
    parent::pre_query();
  }

  /**
   * Use the requested format function to render the raw alias value.
   */
  function render($values) {
    $field_alias = "cid{$this->definition['cid']}";
    $value = $values->{$field_alias};
    $formats = _views_calc_format_options();
    $format = $formats[$this->definition['format']];
    $tmp = explode(':', $format);
    $function = trim($tmp[0]);
    $vars = count($tmp) == 2 ? $tmp[1] : '';
    if ($function == 'custom') {
      $tmp = explode(':', $this->definition['custom']);
      $function = trim($tmp[0]);
      $vars = count($tmp) == 2 ? $tmp[1] : '';
    }
    if (empty($function) || $function == 'none') {
      $function = 'check_plain';
    }
    $raw = $function($value, $vars);

    // This needs to be set for the $this->render_link() to work. It would
    // have been set in the query, if we hadn't bypassed the normal query.
    // TODO there may be a better way to do this.
    $this->aliases['nid'] = 'nid';
    return $this
      ->render_link($raw, $values);
  }

}

Classes

Namesort descending Description
views_calc_field_handler Field handler to provide simple renderer that allows linking to a node.