class views_handler_field_term_node_tid in Views (for Drupal 7) 6.2

Field handler for terms.

Hierarchy

• class \views_object
  • class \views_handler
    • class \views_handler_field
      • class \views_handler_field_prerender_list
        • class \views_handler_field_term_node_tid

1 string reference to 'views_handler_field_term_node_tid'

taxonomy_views_data in modules/taxonomy.views.inc

Implementation of hook_views_data()

File

modules/taxonomy/views_handler_field_term_node_tid.inc, line 6

class views_handler_field_term_node_tid extends views_handler_field_prerender_list {
  function init(&$view, $options) {
    parent::init($view, $options);
    if ($view->base_table == 'node_revisions') {
      $this->additional_fields['vid'] = array(
        'table' => 'node_revisions',
        'field' => 'vid',
      );
    }
    else {
      $this->additional_fields['vid'] = array(
        'table' => 'node',
        'field' => 'vid',
      );
    }
  }
  function option_definition() {
    $options = parent::option_definition();
    $options['link_to_taxonomy'] = array(
      'default' => TRUE,
    );
    $options['limit'] = array(
      'default' => FALSE,
    );
    $options['vids'] = array(
      'default' => array(),
    );
    return $options;
  }

  /**
   * Provide "link to term" option.
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['link_to_taxonomy'] = array(
      '#title' => t('Link this field to its term page'),
      '#type' => 'checkbox',
      '#default_value' => !empty($this->options['link_to_taxonomy']),
    );
    $form['limit'] = array(
      '#type' => 'checkbox',
      '#title' => t('Limit terms by vocabulary'),
      '#default_value' => $this->options['limit'],
    );
    $options = array();
    $vocabularies = taxonomy_get_vocabularies();
    foreach ($vocabularies as $voc) {
      $options[$voc->vid] = check_plain($voc->name);
    }
    $form['vids'] = array(
      '#prefix' => '<div><div id="edit-options-vids">',
      '#suffix' => '</div></div>',
      '#type' => 'checkboxes',
      '#title' => t('Vocabularies'),
      '#options' => $options,
      '#default_value' => $this->options['vids'],
      '#process' => array(
        'expand_checkboxes',
        'views_process_dependency',
      ),
      '#dependency' => array(
        'edit-options-limit' => array(
          TRUE,
        ),
      ),
    );
  }

  /**
   * Add this term to the query
   */
  function query() {
    $this
      ->add_additional_fields();
  }
  function pre_render(&$values) {
    $this->field_alias = $this->aliases['vid'];
    $vids = array();
    foreach ($values as $result) {
      if (!empty($result->{$this->aliases['vid']})) {
        $vids[] = $result->{$this->aliases['vid']};
      }
    }
    if ($vids) {
      $voc = '';
      $voc_ids = array_filter($this->options['vids']);
      if (!empty($this->options['limit']) && !empty($voc_ids)) {
        $voc = " AND t.vid IN (" . implode(', ', array_keys($voc_ids)) . ")";
      }
      $result = db_query("SELECT tn.vid AS node_vid, t.*, v.name as vocabulary FROM {term_data} t INNER JOIN {term_node} tn ON t.tid = tn.tid INNER JOIN {vocabulary} v ON v.vid = t.vid WHERE tn.vid IN (" . implode(', ', $vids) . "){$voc} ORDER BY t.weight, t.name");
      while ($term = db_fetch_object($result)) {
        $this->items[$term->node_vid][$term->tid]['name'] = check_plain($term->name);
        $this->items[$term->node_vid][$term->tid]['tid'] = $term->tid;
        $this->items[$term->node_vid][$term->tid]['vid'] = $term->vid;
        $this->items[$term->node_vid][$term->tid]['vocabulary'] = check_plain($term->vocabulary);
        if (!empty($this->options['link_to_taxonomy'])) {
          $this->items[$term->node_vid][$term->tid]['make_link'] = TRUE;
          $this->items[$term->node_vid][$term->tid]['path'] = taxonomy_term_path($term);
        }
      }
    }
  }
  function render_item($count, $item) {
    return $item['name'];
  }
  function document_self_tokens(&$tokens) {
    $tokens['[' . $this->options['id'] . '-tid' . ']'] = t('The taxonomy term ID for the term.');
    $tokens['[' . $this->options['id'] . '-name' . ']'] = t('The taxonomy term name for the term.');
    $tokens['[' . $this->options['id'] . '-vid' . ']'] = t('The vocabulary ID for the vocabulary the term belongs to.');
    $tokens['[' . $this->options['id'] . '-vocabulary' . ']'] = t('The name for the vocabulary the term belongs to.');
  }
  function add_self_tokens(&$tokens, $item) {
    $tokens['[' . $this->options['id'] . '-tid' . ']'] = $item['tid'];
    $tokens['[' . $this->options['id'] . '-name' . ']'] = $item['name'];
    $tokens['[' . $this->options['id'] . '-vid' . ']'] = $item['vid'];
    $tokens['[' . $this->options['id'] . '-vocabulary' . ']'] = $item['vocabulary'];
  }

}

Members

Name	Modifiers	Type	Description	Overrides
views_handler::accept_exposed_input		function	Take input from exposed filters and assign to this handler, if necessary.	1
views_handler::access		function	Check whether current user has access to this handler.	5
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.	5
views_handler::can_expose		function	Determine if a handler can be exposed.	1
views_handler::ensure_my_table		function	Ensure the main table for this handler is in the query. This is used a lot.	7
views_handler::exposed_form		function	Render our chunk of the exposed filter form when selecting	1
views_handler::exposed_info		function	Get information about the exposed form for the form renderer.	1
views_handler::exposed_submit		function	Submit the exposed filter form
views_handler::exposed_validate		function	Validate the exposed filter form	4
views_handler::expose_options		function	Set new exposed option defaults when exposed setting is flipped on.	1
views_handler::extra_options		function	Provide defaults for the handler.
views_handler::extra_options_form		function	Provide a form for setting options.	1
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.	1
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.	1
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.	1
views_handler::options_validate		function	Validate the options form.	1
views_handler::pre_query		function	Run before the view is built.	1
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.	1
views_handler::ui_name		function	Return a string representing this handler's name in the UI.	5
views_handler::validate		function	Validates the handler against the complete View.
views_handler_field::$aliases		property
views_handler_field::$field_alias		property
views_handler_field::add_additional_fields		function	Add 'additional' fields to the query.
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::click_sort		function	Called to determine what to tell the clicksorter.	1
views_handler_field::click_sortable		function	Determine if this field is click sortable.
views_handler_field::construct		function	Construct a new field handler. Overrides views_object::construct	18
views_handler_field::element_type		function	Return DIV or SPAN based upon the field's element type.	2
views_handler_field::get_render_tokens		function	Get the 'render' tokens to use for advanced rendering.
views_handler_field::label		function	Get this field's label.
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_prerender_list::allow_advanced_render		function	Determine if advanced rendering is allowed. Overrides views_handler_field::allow_advanced_render
views_handler_field_prerender_list::get_items		function	Return an array of items for the field.
views_handler_field_prerender_list::render		function	Render the field. Overrides views_handler_field::render
views_handler_field_prerender_list::render_items		function	Render all items in this field together.
views_handler_field_term_node_tid::add_self_tokens		function	Add any special tokens this field might use for itself. Overrides views_handler_field::add_self_tokens
views_handler_field_term_node_tid::document_self_tokens		function	Document any special tokens this field might use for itself. Overrides views_handler_field::document_self_tokens
views_handler_field_term_node_tid::init		function	init the handler with necessary data. Overrides views_handler_field::init
views_handler_field_term_node_tid::options_form		function	Provide "link to term" option. Overrides views_handler_field_prerender_list::options_form
views_handler_field_term_node_tid::option_definition		function	Information about options for all kinds of purposes will be held here. Overrides views_handler_field_prerender_list::option_definition
views_handler_field_term_node_tid::pre_render		function	Run before any fields are rendered. Overrides views_handler_field::pre_render
views_handler_field_term_node_tid::query		function	Add this term to the query Overrides views_handler_field::query
views_handler_field_term_node_tid::render_item		function
views_object::$options		property	Except for displays, options for the object will be held here.	1
views_object::destroy		function		2
views_object::options		function	Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility.	1
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		1