class views_handler_argument_term_node_tid_depth in Views (for Drupal 7) 6.2

Argument handler for taxonomy terms with depth.

This handler is actually part of the node table and has some restrictions, because it uses a subquery to find nodes with

Hierarchy

• class \views_object
  • class \views_handler
    • class \views_handler_argument
      • class \views_handler_argument_term_node_tid_depth

1 string reference to 'views_handler_argument_term_node_tid_depth'

taxonomy_views_data_alter in modules/taxonomy.views.inc

Implementation of hook_views_data_alter().

File

modules/taxonomy/views_handler_argument_term_node_tid_depth.inc, line 8

class views_handler_argument_term_node_tid_depth extends views_handler_argument {
  function option_definition() {
    $options = parent::option_definition();
    $options['depth'] = array(
      'default' => 0,
    );
    $options['break_phrase'] = array(
      'default' => FALSE,
    );
    $options['set_breadcrumb'] = array(
      'default' => FALSE,
    );
    $options['use_taxonomy_term_path'] = array(
      'default' => FALSE,
    );
    return $options;
  }
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);
    $form['depth'] = array(
      '#type' => 'weight',
      '#title' => t('Depth'),
      '#default_value' => $this->options['depth'],
      '#description' => t('The depth will match nodes tagged with terms in the hierarchy. For example, if you have the term "fruit" and a child term "apple", with a depth of 1 (or higher) then filtering for the term "fruit" will get nodes that are tagged with "apple" as well as "fruit". If negative, the reverse is true; searching for "apple" will also pick up nodes tagged with "fruit" if depth is -1 (or lower).'),
    );
    $form['break_phrase'] = array(
      '#type' => 'checkbox',
      '#title' => t('Allow multiple terms per argument'),
      '#description' => t('If selected, users can enter multiple arguments in the form of 1+2+3. Due to the number of JOINs it would require, AND will be treated as OR with this argument.'),
      '#default_value' => !empty($this->options['break_phrase']),
    );
    $form['set_breadcrumb'] = array(
      '#type' => 'checkbox',
      '#title' => t("Set the breadcrumb for the term parents"),
      '#description' => t('If selected, the breadcrumb trail will include all parent terms, each one linking to this view. Note that this only works if just one term was received.'),
      '#default_value' => !empty($this->options['set_breadcrumb']),
    );
    $form['use_taxonomy_term_path'] = array(
      '#type' => 'checkbox',
      '#title' => t("Use Drupal's taxonomy term path to create breadcrumb links"),
      '#description' => t('If selected, the links in the breadcrumb trail will be created using the standard drupal method instead of the custom views method. This is useful if you are using modules like taxonomy redirect to modify your taxonomy term links.'),
      '#default_value' => !empty($this->options['use_taxonomy_term_path']),
      '#process' => array(
        'views_process_dependency',
      ),
      '#dependency' => array(
        'edit-options-set-breadcrumb' => array(
          TRUE,
        ),
      ),
    );
  }
  function set_breadcrumb(&$breadcrumb) {
    if (empty($this->options['set_breadcrumb']) || !is_numeric($this->argument)) {
      return;
    }
    return views_taxonomy_set_breadcrumb($breadcrumb, $this);
  }

  /**
   * Override default_actions() to remove summary actions.
   */
  function default_actions($which = NULL) {
    if ($which) {
      if (in_array($which, array(
        'ignore',
        'not found',
        'empty',
        'default',
      ))) {
        return parent::default_actions($which);
      }
      return;
    }
    $actions = parent::default_actions();
    unset($actions['summary asc']);
    unset($actions['summary desc']);
    return $actions;
  }
  function query() {
    $this
      ->ensure_my_table();
    if (!empty($this->options['break_phrase'])) {
      $tids = new stdClass();
      $tids->value = $this->argument;
      $tids = views_break_phrase($this->argument, $tids);
      if ($tids->value == -1) {
        return FALSE;
      }
      if (count($tids->value) > 1) {
        $placeholder = " IN (" . implode(', ', array_fill(0, sizeof($tids->value), '%d')) . ")";
      }
      else {
        $placeholder = " = %d";
      }
      $tids = $tids->value;
    }
    else {
      $placeholder = "= %d";
      $tids = array(
        $this->argument,
      );
    }
    $subquery = "\n  SELECT tn.vid FROM {term_node} tn\n";
    $where = "  WHERE tn.tid {$placeholder}\n";
    $args = $tids;
    $last = "tn";
    if ($this->options['depth'] > 0) {
      $subquery .= "    LEFT JOIN {term_hierarchy} th ON th.tid = tn.tid\n";
      $last = "th";
      foreach (range(1, abs($this->options['depth'])) as $count) {
        $subquery .= "    LEFT JOIN {term_hierarchy} th{$count} ON {$last}.parent = th{$count}.tid\n";
        $where .= "    OR th{$count}.tid {$placeholder}\n";
        $args = array_merge($args, $tids);
        $last = "th{$count}";
      }
    }
    else {
      if ($this->options['depth'] < 0) {
        foreach (range(1, abs($this->options['depth'])) as $count) {
          $subquery .= "    LEFT JOIN {term_hierarchy} th{$count} ON {$last}.tid = th{$count}.parent\n";
          $where .= "    OR th{$count}.tid {$placeholder}\n";
          $args = array_merge($args, $tids);
          $last = "th{$count}";
        }
      }
    }
    $this->query
      ->add_where(0, "{$this->table_alias}.{$this->real_field} IN ({$subquery}{$where}  )", $args);
  }
  function title() {
    $term = taxonomy_get_term($this->argument);
    if (!empty($term)) {
      return check_plain($term->name);
    }

    // TODO review text
    return t('No name');
  }

}

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::admin_summary		function	Provide text for the administrative summary	3
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::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_argument::$name_field		property
views_handler_argument::construct		function	Constructor Overrides views_object::construct	6
views_handler_argument::default_action		function	Handle the default action, which means our argument wasn't present.
views_handler_argument::default_argument_form		function	Provide a form for selecting the default argument when the default action is set to provide default argument.	1
views_handler_argument::default_default		function	This just returns true. The view argument builder will know where to find the argument from.
views_handler_argument::default_empty		function	Default action: empty
views_handler_argument::default_ignore		function	Default action: ignore.
views_handler_argument::default_not_found		function	Default action: not found.
views_handler_argument::default_summary		function	Default action: summary.
views_handler_argument::get_default_argument		function	Get a default argument, if available.	1
views_handler_argument::get_title		function	Called by the view object to get the title. This may be set by a validator so we don't necessarily call through to title().
views_handler_argument::get_value		function	Get the value of this argument.
views_handler_argument::has_default_argument		function	Determine if the argument is set to provide a default argument.
views_handler_argument::init		function	init the handler with necessary data. Overrides views_handler::init	2
views_handler_argument::is_wildcard		function
views_handler_argument::needs_style_plugin		function	Determine if the argument needs a style plugin. Overrides views_handler::needs_style_plugin
views_handler_argument::set_argument		function	Set the input for this argument
views_handler_argument::summary_argument		function	Provide the argument to use to link from the summary to the next level; this will be called once per row of a summary, and used as part of $view->get_url().	4
views_handler_argument::summary_basics		function	Some basic summary behavior that doesn't need to be repeated as much as code that goes into summary_query()
views_handler_argument::summary_name		function	Provides the name to use for the summary. By default this is just the name field.	11
views_handler_argument::summary_name_field		function	Add the name field, which is the field displayed in summary queries. This is often used when the argument is numeric.
views_handler_argument::summary_query		function	Build the info for the summary query.	3
views_handler_argument::summary_sort		function	Sorts the summary based upon the user's selection. The base variant of this is usually adequte.
views_handler_argument::uses_breadcrumb		function	Determine if the argument can generate a breadcrumb
views_handler_argument::validate_arg		function	Validate that this argument works. By default, all arguments are valid.
views_handler_argument::validate_argument		function	Called by the menu system to validate an argument.
views_handler_argument::validate_argument_basic		function	Provide a basic argument validation.	1
views_handler_argument::validate_fail		function	How to act if validation failes
views_handler_argument::wildcard_title		function
views_handler_argument_term_node_tid_depth::default_actions		function	Override default_actions() to remove summary actions. Overrides views_handler_argument::default_actions
views_handler_argument_term_node_tid_depth::options_form		function	Provide a form for setting options. Overrides views_handler_argument::options_form
views_handler_argument_term_node_tid_depth::option_definition		function	Information about options for all kinds of purposes will be held here. Overrides views_handler_argument::option_definition
views_handler_argument_term_node_tid_depth::query		function	Set up the query for this argument. Overrides views_handler_argument::query
views_handler_argument_term_node_tid_depth::set_breadcrumb		function	Give an argument the opportunity to modify the breadcrumb, if it wants. This only gets called on displays where a breadcrumb is actually used. Overrides views_handler_argument::set_breadcrumb
views_handler_argument_term_node_tid_depth::title		function	Get the title this argument will assign the view, given the argument. Overrides views_handler_argument::title
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