TaxonomyIndexTidDepth.php 3.68 KB
Newer Older
1 2 3 4
<?php

/**
 * @file
5
 * Definition of Drupal\taxonomy\Plugin\views\filter\TaxonomyIndexTidDepth.
6 7
 */

8
namespace Drupal\taxonomy\Plugin\views\filter;
9

10
use Drupal\Component\Annotation\PluginID;
11

12 13 14 15 16 17 18
/**
 * Filter 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.
 *
 * @ingroup views_filter_handlers
19
 *
20
 * @PluginID("taxonomy_index_tid_depth")
21 22
 */
class TaxonomyIndexTidDepth extends TaxonomyIndexTid {
23

24
  public function operatorOptions($which = 'title') {
25 26 27 28 29
    return array(
      'or' => t('Is one of'),
    );
  }

30 31
  protected function defineOptions() {
    $options = parent::defineOptions();
32 33 34 35 36 37

    $options['depth'] = array('default' => 0);

    return $options;
  }

38 39
  public function buildExtraOptionsForm(&$form, &$form_state) {
    parent::buildExtraOptionsForm($form, $form_state);
40 41 42 43 44 45 46 47 48

    $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).'),
    );
  }

49
  public function query() {
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64
    // If no filter values are present, then do nothing.
    if (count($this->value) == 0) {
      return;
    }
    elseif (count($this->value) == 1) {
      // Somethis $this->value is an array with a single element so convert it.
      if (is_array($this->value)) {
        $this->value = current($this->value);
      }
      $operator = '=';
    }
    else {
      $operator = 'IN';# " IN (" . implode(', ', array_fill(0, sizeof($this->value), '%d')) . ")";
    }

65
    // The normal use of ensureMyTable() here breaks Views.
66 67 68 69
    // So instead we trick the filter into using the alias of the base table.
    // See http://drupal.org/node/271833
    // If a relationship is set, we must use the alias it provides.
    if (!empty($this->relationship)) {
70
      $this->tableAlias = $this->relationship;
71 72
    }
    // If no relationship, then use the alias of the base table.
73 74
    elseif (isset($this->query->table_queue[$this->view->storage->get('base_table')]['alias'])) {
      $this->tableAlias = $this->query->table_queue[$this->view->storage->get('base_table')]['alias'];
75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104
    }
    // This should never happen, but if it does, we fail quietly.
    else {
      return;
    }

    // Now build the subqueries.
    $subquery = db_select('taxonomy_index', 'tn');
    $subquery->addField('tn', 'nid');
    $where = db_or()->condition('tn.tid', $this->value, $operator);
    $last = "tn";

    if ($this->options['depth'] > 0) {
      $subquery->leftJoin('taxonomy_term_hierarchy', 'th', "th.tid = tn.tid");
      $last = "th";
      foreach (range(1, abs($this->options['depth'])) as $count) {
        $subquery->leftJoin('taxonomy_term_hierarchy', "th$count", "$last.parent = th$count.tid");
        $where->condition("th$count.tid", $this->value, $operator);
        $last = "th$count";
      }
    }
    elseif ($this->options['depth'] < 0) {
      foreach (range(1, abs($this->options['depth'])) as $count) {
        $subquery->leftJoin('taxonomy_term_hierarchy', "th$count", "$last.tid = th$count.parent");
        $where->condition("th$count.tid", $this->value, $operator);
        $last = "th$count";
      }
    }

    $subquery->condition($where);
105
    $this->query->add_where($this->options['group'], "$this->tableAlias.$this->realField", $subquery, 'IN');
106
  }
107

108
}