class views_handler_field_node_optional

@file Field handler to provide simple renderer that allows linking to a node.

Hierarchy

Expanded class hierarchy of views_handler_field_node_optional

Related topics

Tripal Core Module

File

tripal_views/views/handlers/deprecated/views_handler_field_node_optional.inc, line 10
Field handler to provide simple renderer that allows linking to a node.

View source
class views_handler_field_node_optional extends views_handler_field_node {

  function construct() {
    parent::construct();
    $this->additional_fields['nid'] = array('table' => 'node', 'field' => 'nid');
    if (module_exists('translation')) {
      $this->additional_fields['language'] = array('table' => 'node', 'field' => 'language');
    }
  }

  /**
   * Add chado_* and *_node alias'd left joins to the table
   */
  function query() {

    // Check what we have (ie: current table? node table? )
    $chado_table = 'chado_' . $this->table;
    foreach ($this->query->table_queue as $table_def) {
      //check is $this->table
      if ($table_def['table'] == $this->table) {
        $this_table_alias = $table_def['alias'];
      }

      // check is node joined to #this->table
      if ($table_def['table'] == $chado_table) {
        $node_table_alias = $table_def['alias'];
      }
    }

    // First: Add the main field-----------------------------------------------
    if (!$this_table_alias) {
      $this_table_alias = $this->ensure_my_table();
    }
    $field_alias = $this->query->add_field($this_table_alias, $this->real_field);
    $this->aliases[$this->real_field] = $field_alias;
    $this->field_alias = $field_alias;

    // Second: Add nid field and Joins if necessary----------------------------
    // Add node join if needed
    if (!$node_table_alias) {
      $def['table'] = $chado_table;
      $def['field'] = $this->table . '_id';
      $def['left_table'] = $this_table_alias;
      $def['left_field'] = $this->table . '_id';

      $join = new views_join();
      $join->definition = $def;
      $join->construct();
      $join->adjusted = TRUE;

      $node_table_alias = $this->query->add_relationship($def['table'], $join, $def['table']);
    }

    // Finally Add Field
    $field_alias = $this->query->add_field($node_table_alias, 'nid');
    $this->aliases['nid'] = $field_alias;

  }

  /**
   * 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']) && $data !== NULL && $data !== '') {
      if (!empty($values->{$this->aliases['nid']})) {
        $this->options['alter']['make_link'] = TRUE;
        $this->options['alter']['path'] = "node/" . $values->{$this->aliases['nid']};
        if (isset($this->aliases['language'])) {
          $languages = language_list();
          if (isset($languages[$values->{$this->aliases['language']}])) {
            $this->options['alter']['language'] = $languages[$values->{$this->aliases['language']}];
          }
          else {
            unset($this->options['alter']['language']);
          }
        }
      }
      else {
        $this->options['alter']['make_link'] = FALSE;
        $this->options['alter']['path'] = "";
      }
    }

    return $data;
  }
}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
views_handler::accept_exposed_input function Take input from exposed filters and assign to this handler, if necessary.
views_handler::access function Check whether current user has access to this handler.
views_handler::broken function Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found.
views_handler::can_expose function Determine if a handler can be exposed.
views_handler::ensure_my_table function Ensure the main table for this handler is in the query. This is used a lot.
views_handler::exposed_form function Render our chunk of the exposed filter form when selecting
views_handler::exposed_info function Get information about the exposed form for the form renderer.
views_handler::exposed_submit function Submit the exposed filter form
views_handler::exposed_validate function Validate the exposed filter form
views_handler::expose_options function Set new exposed option defaults when exposed setting is flipped on.
views_handler::extra_options function Provide defaults for the handler.
views_handler::extra_options_form function Provide a form for setting options.
views_handler::extra_options_submit function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.
views_handler::extra_options_validate function Validate the options form.
views_handler::get_join function Get the join object that should be used for this handler.
views_handler::has_extra_options function If a handler has 'extra options' it will get a little settings widget and another form called extra_options.
views_handler::is_exposed function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
views_handler::needs_style_plugin function Determine if the argument needs a style plugin.
views_handler::options_submit function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data.
views_handler::options_validate function Validate the options form.
views_handler::pre_query function Run before the view is built.
views_handler::set_relationship function Called just prior to query(), this lets a handler set up any relationship it needs.
views_handler::store_exposed_input function If set to remember exposed input in the session, store it there.
views_handler::ui_name function Return a string representing this handler's name in the UI.
views_handler::validate function Validates the handler against the complete View.
views_handler_field::add_additional_fields function Add 'additional' fields to the query.
views_handler_field::add_self_tokens function Add any special tokens this field might use for itself.
views_handler_field::admin_summary function Provide extra data to the administration form Overrides views_handler::admin_summary
views_handler_field::advanced_render function Render a field using advanced settings.
views_handler_field::allow_advanced_render function Determine if this field can allow advanced rendering.
views_handler_field::click_sort function Called to determine what to tell the clicksorter.
views_handler_field::click_sortable function Determine if this field is click sortable.
views_handler_field::document_self_tokens function Document any special tokens this field might use for itself.
views_handler_field::element_type function Return DIV or SPAN based upon the field's element type.
views_handler_field::get_render_tokens function Get the 'render' tokens to use for advanced rendering.
views_handler_field::init function init the handler with necessary data. Overrides views_handler::init
views_handler_field::label function Get this field's label.
views_handler_field::pre_render function Run before any fields are rendered.
views_handler_field::render_altered function Render this field as altered text, from a fieldset set by the user.
views_handler_field::render_as_link function Render this field as a link, with the info from a fieldset set by the user.
views_handler_field::render_text function Perform an advanced text render for the item.
views_handler_field::render_trim_text function Trim the field down to the specified length.
views_handler_field::theme function Call out to the theme() function, which probably just calls render() but allows sites to override output fairly easily.
views_handler_field::theme_functions function
views_handler_field_node::options_form function Provide link to node option Overrides views_handler_field::options_form
views_handler_field_node::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_handler_field::option_definition
views_handler_field_node::render function Render the field. Overrides views_handler_field::render
views_handler_field_node_optional::construct function Constructor to provide additional field to add. Overrides views_handler_field_node::construct
views_handler_field_node_optional::query function Add chado_* and *_node alias'd left joins to the table Overrides views_handler_field::query
views_handler_field_node_optional::render_link function Render whatever the data is as a link to the node. Overrides views_handler_field_node::render_link
views_object::destroy function
views_object::options function Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility.
views_object::set_default_options function Set default options. For backward compatibility, it sends the options array; this is a feature that will likely disappear at some point.
views_object::set_definition function Let the handler know what its full definition is.
views_object::unpack_options function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::_set_option_defaults function