ShsChosenTaxonomyIndexTidDepth.php in Simple hierarchical select 2.0.x

Namespace

Drupal\shs_chosen\Plugin\views\filter

File

modules/shs_chosen/src/Plugin/views/filter/ShsChosenTaxonomyIndexTidDepth.php

<?php

namespace Drupal\shs_chosen\Plugin\views\filter;

use Drupal\Core\Form\FormStateInterface;
use Drupal\Core\Database\Connection;
use Drupal\Core\Database\Query\Condition;
use Drupal\taxonomy\TermStorageInterface;
use Drupal\taxonomy\VocabularyStorageInterface;
use Symfony\Component\DependencyInjection\ContainerInterface;

/**
 * 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
 *
 * @ViewsFilter("shs_chosen_taxonomy_index_tid_depth")
 */
class ShsChosenTaxonomyIndexTidDepth extends ShsChosenTaxonomyIndexTid {

  /**
   * The variable to store database connection object.
   *
   * @var \Drupal\Core\Database\Connection
   */
  protected $database;

  /**
   * Constructor for the class.
   *
   * @param array $configuration
   *   The configuration array.
   * @param string $plugin_id
   *   The Plugin id.
   * @param mixed $plugin_definition
   *   The Plugin definition.
   * @param \Drupal\taxonomy\VocabularyStorageInterface $vocabulary_storage
   *   The vocabulary storage.
   * @param \Drupal\taxonomy\TermStorageInterface $term_storage
   *   The term storage.
   * @param \Drupal\Core\Session\AccountInterface $current_user
   *   The current user.
   * @param \Drupal\Core\Database\Connection $database
   *   The database connection.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, VocabularyStorageInterface $vocabulary_storage, TermStorageInterface $term_storage, AccountInterface $current_user, Connection $database) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $vocabulary_storage, $term_storage, $current_user);
    $this->database = $database;

    // Set translation context.
    $this->translationContext = 'shs_chosen:taxonomy_index_tid_depth';
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('entity_type.manager')
      ->getStorage('taxonomy_vocabulary'), $container
      ->get('entity_type.manager')
      ->getStorage('taxonomy_term'), $container
      ->get('current_user'), $container
      ->get('database'));
  }

  /**
   * {@inheritdoc}
   */
  public function operatorOptions($which = 'title') {
    return [
      'or' => $this
        ->t('Is one of'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['depth'] = [
      'default' => 0,
    ];
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function buildExtraOptionsForm(&$form, FormStateInterface $form_state) {
    parent::buildExtraOptionsForm($form, $form_state);
    $form['depth'] = [
      '#type' => 'weight',
      '#title' => $this
        ->t('Depth'),
      '#default_value' => $this->options['depth'],
      '#description' => $this
        ->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).'),
    ];
  }

  /**
   * {@inheritdoc}
   */
  public function query() {

    // If no filter values are present, then do nothing.
    if (count($this->value) == 0) {
      return;
    }
    elseif (count($this->value) == 1) {

      // Sometimes $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';
    }

    // The normal use of ensureMyTable() here breaks Views.
    // So instead we trick the filter into using the alias of the base table.
    // See https://www.drupal.org/node/271833.
    // If a relationship is set, we must use the alias it provides.
    if (!empty($this->relationship)) {
      $this->tableAlias = $this->relationship;
    }
    else {
      $this->tableAlias = $this->query
        ->ensureTable($this->view->storage
        ->get('base_table'));
    }

    // Now build the subqueries.
    $subquery = $this->database
      ->select('taxonomy_index', 'tn');
    $subquery
      ->addField('tn', 'nid');
    $or_condition = new Condition('OR');
    $where = $or_condition
      ->condition('tn.tid', $this->value, $operator);
    $last = "tn";
    if ($this->options['depth'] > 0) {
      $subquery
        ->leftJoin('taxonomy_term__parent', 'tp', "tp.entity_id = tn.tid");
      $last = "tp";
      foreach (range(1, abs($this->options['depth'])) as $count) {
        $subquery
          ->leftJoin('taxonomy_term__parent', "tp{$count}", "{$last}.parent_target_id = tp{$count}.entity_id");
        $where
          ->condition("tp{$count}.entity_id", $this->value, $operator);
        $last = "tp{$count}";
      }
    }
    elseif ($this->options['depth'] < 0) {
      foreach (range(1, abs($this->options['depth'])) as $count) {
        $subquery
          ->leftJoin('taxonomy_term__parent', "tp{$count}", "{$last}.entity_id = tp{$count}.parent_target_id");
        $where
          ->condition("tp{$count}.entity_id", $this->value, $operator);
        $last = "tp{$count}";
      }
    }
    $subquery
      ->condition($where);
    $this->query
      ->addWhere($this->options['group'], "{$this->tableAlias}.{$this->realField}", $subquery, 'IN');
  }

}

Classes

Name	Description
ShsChosenTaxonomyIndexTidDepth	Filter handler for taxonomy terms with depth.