class nat_handler_argument_term_node_tid_depth in Node Auto Term [NAT] 6

Argument handler for NAT terms over NAT nid 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 \nat_handler_argument_term_node_tid_depth extends \views_handler_argument

1 string reference to 'nat_handler_argument_term_node_tid_depth'

nat_views_data_alter in includes/nat.views.inc

Implementation of hook_views_data_alter().

File

includes/nat_handler_argument_term_node_tid_depth.inc, line 15

NAT (Node Auto Term) nid views argument with depth handler.

class nat_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,
    );
    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']),
    );
  }
  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";
      }
      foreach ($tids->value as $tid) {
        $nat_tid = nat_get_term($tid);
        $nat_tids[] = $nat_tid->tid;
      }
      $tids = $nat_tids;
    }
    else {
      $placeholder = "= %d";
      $tids = array(
        $this->argument,
      );
      $nat_tid = nat_get_term($this->argument);
      $tids = array(
        $nat_tid->tid,
      );
    }
    $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}";
      }
    }
    elseif ($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
nat_handler_argument_term_node_tid_depth::default_actions		function	Override default_actions() to remove summary actions.
nat_handler_argument_term_node_tid_depth::options_form		function
nat_handler_argument_term_node_tid_depth::option_definition		function
nat_handler_argument_term_node_tid_depth::query		function
nat_handler_argument_term_node_tid_depth::set_breadcrumb		function
nat_handler_argument_term_node_tid_depth::title		function