View source
<?php
namespace Drupal\views_taxonomy_term_name_depth\Plugin\views\argument;
use Drupal\Core\Database\Connection;
use Drupal\Core\Database\Query\Condition;
use Drupal\Core\Entity\EntityStorageInterface;
use Drupal\Core\Form\FormStateInterface;
use Drupal\taxonomy\Entity\Vocabulary;
use Drupal\views\Plugin\views\argument\ArgumentPluginBase;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Drupal\Core\Extension\ModuleHandlerInterface;
use Drupal\pathauto\AliasCleanerInterface;
class IndexNameDepth extends ArgumentPluginBase {
protected $termStorage;
protected $database;
protected $moduleHandler;
protected $pathautoAliasCleaner;
public function __construct(array $configuration, $plugin_id, $plugin_definition, EntityStorageInterface $termStorage, Connection $database, ModuleHandlerInterface $module_handler, AliasCleanerInterface $pathauto_alias_cleaner) {
parent::__construct($configuration, $plugin_id, $plugin_definition);
$this->termStorage = $termStorage;
$this->database = $database;
$this->moduleHandler = $module_handler;
$this->pathautoAliasCleaner = $pathauto_alias_cleaner;
}
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_term'), $container
->get('database'), $container
->get('module_handler'), $container
->get('pathauto.alias_cleaner'));
}
protected function defineOptions() {
$options = parent::defineOptions();
$options['depth'] = [
'default' => 0,
];
$options['vocabularies'] = [
'default' => [],
];
$options['break_phrase'] = [
'default' => FALSE,
];
$options['use_taxonomy_term_path'] = [
'default' => FALSE,
];
return $options;
}
public function buildOptionsForm(&$form, FormStateInterface $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).'),
];
$vocabularies = Vocabulary::loadMultiple();
$vocab_options = [];
foreach ($vocabularies as $machine_name => $vocabulary) {
$vocab_options[$machine_name] = $vocabulary
->label();
}
$form['vocabularies'] = [
'#type' => 'select',
'#title' => $this
->t('Vocabularies'),
'#default_value' => $this->options['vocabularies'],
'#options' => $vocab_options,
'#multiple' => TRUE,
'#description' => $this
->t('Choose the vocabularies to check against. This is useful if you have terms of the same name across different vocabularies.'),
];
$form['break_phrase'] = [
'#type' => 'checkbox',
'#title' => $this
->t('Allow multiple values'),
'#description' => $this
->t('If selected, users can enter multiple values in the form of 1+2+3. Due to the number of JOINs it would require, AND will be treated as OR with this filter.'),
'#default_value' => !empty($this->options['break_phrase']),
];
parent::buildOptionsForm($form, $form_state);
}
protected function defaultActions($which = NULL) {
if ($which) {
if (in_array($which, [
'ignore',
'not found',
'empty',
'default',
])) {
return parent::defaultActions($which);
}
return FALSE;
}
$actions = parent::defaultActions();
unset($actions['summary asc']);
unset($actions['summary desc']);
unset($actions['summary asc by count']);
unset($actions['summary desc by count']);
return $actions;
}
public function query($group_by = FALSE) {
$this
->ensureMyTable();
if (!empty($this->options['break_phrase'])) {
$break = static::breakString($this->argument);
if ($break->value === [
-1,
]) {
return FALSE;
}
$operator = count($break->value) > 1 ? 'IN' : '=';
$tids = $break->value;
}
else {
$operator = "=";
$tids = $this->argument;
}
if (is_string($tids)) {
if ($this->moduleHandler
->moduleExists('pathauto')) {
$query = $this->database
->select('taxonomy_term_field_data', 't')
->fields('t', [
'tid',
'name',
]);
if (!empty($this->options['vocabularies'])) {
$query
->condition('t.vid', $this->options['vocabularies'], 'IN');
}
$results = $query
->execute()
->fetchAll(\PDO::FETCH_OBJ);
foreach ($results as $row) {
if ($this->pathautoAliasCleaner
->cleanString($row->name) == $this->pathautoAliasCleaner
->cleanString($tids)) {
$tids = $row->tid;
}
}
}
else {
$argument = str_replace('-', ' ', $tids);
$query = $this->database
->select('taxonomy_term_field_data', 't')
->fields('t', [
'tid',
'name',
]);
if (!empty($this->options['vocabularies'])) {
$query
->condition('t.vid', $this->options['vocabularies'], 'IN');
}
$query
->condition('t.name', $argument, '=');
$results = $query
->execute()
->fetchAll(\PDO::FETCH_OBJ);
foreach ($results as $row) {
$tids = $row->tid;
}
}
}
$subquery = $this->database
->select('taxonomy_index', 'tn');
$subquery
->addField('tn', 'nid');
$where = (new Condition('OR'))
->condition('tn.tid', $tids, $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", $tids, $operator);
$last = "tp{$count}";
}
}
elseif ($this->options['depth'] < 0) {
foreach (range(1, abs($this->options['depth'])) as $count) {
$field = $count == 1 ? 'tid' : 'entity_id';
$subquery
->leftJoin('taxonomy_term__parent', "tp{$count}", "{$last}.{$field} = tp{$count}.parent_target_id");
$where
->condition("tp{$count}.entity_id", $tids, $operator);
$last = "tp{$count}";
}
}
$subquery
->condition($where);
$this->query
->addWhere(0, "{$this->tableAlias}.{$this->realField}", $subquery, 'IN');
}
public function title() {
$term = $this->termStorage
->load($this->argument);
if ($this->moduleHandler
->moduleExists('pathauto')) {
$query = $this->database
->select('taxonomy_term_field_data', 't')
->fields('t', [
'tid',
'name',
]);
if (!empty($this->options['vocabularies'])) {
$query
->condition('t.vid', $this->options['vocabularies'], 'IN');
}
$results = $query
->execute()
->fetchAll(\PDO::FETCH_OBJ);
foreach ($results as $row) {
if ($this->pathautoAliasCleaner
->cleanString($row->name) == $this->pathautoAliasCleaner
->cleanString($this->argument)) {
$tid = $row->tid;
$term = current($this->termStorage
->loadByProperties([
'tid' => $tid,
]));
break;
}
}
}
if (empty($term)) {
$term = current($this->termStorage
->loadByProperties([
'name' => str_replace('-', ' ', $this->argument),
]));
}
if (!empty($term)) {
return $term
->getName();
}
}
}