class TaxonomyIndexTidDepth in Drupal 10

Same name and namespace in other branches

8 core/modules/taxonomy/src/Plugin/views/filter/TaxonomyIndexTidDepth.php \Drupal\taxonomy\Plugin\views\filter\TaxonomyIndexTidDepth
9 core/modules/taxonomy/src/Plugin/views/filter/TaxonomyIndexTidDepth.php \Drupal\taxonomy\Plugin\views\filter\TaxonomyIndexTidDepth

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.

Plugin annotation

@ViewsFilter("taxonomy_index_tid_depth");

Hierarchy

class \Drupal\views\Plugin\views\filter\FilterPluginBase extends \Drupal\views\Plugin\views\HandlerBase implements CacheableDependencyInterface
- class \Drupal\views\Plugin\views\filter\InOperator
  - class \Drupal\views\Plugin\views\filter\ManyToOne
    class \Drupal\taxonomy\Plugin\views\filter\TaxonomyIndexTid
    class \Drupal\taxonomy\Plugin\views\filter\TaxonomyIndexTidDepth uses TaxonomyIndexDepthQueryTrait

Expanded class hierarchy of TaxonomyIndexTidDepth

File

core/modules/taxonomy/src/Plugin/views/filter/TaxonomyIndexTidDepth.php, line 18

Namespace

Drupal\taxonomy\Plugin\views\filter

View source

class TaxonomyIndexTidDepth extends TaxonomyIndexTid {
  use TaxonomyIndexDepthQueryTrait;
  public function operatorOptions($which = 'title') {
    return [
      'or' => $this
        ->t('Is one of'),
    ];
  }
  protected function defineOptions() {
    $options = parent::defineOptions();
    $options['depth'] = [
      'default' => 0,
    ];
    return $options;
  }
  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).'),
    ];
  }
  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);
      }
    }

    // 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'));
    }
    $this
      ->addSubQueryJoin($this->value);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
FilterPluginBase::$alwaysMultiple	protected	property	Disable the possibility to force a single value.	4
FilterPluginBase::$always_required	public	property	Disable the possibility to allow an exposed input to be optional.
FilterPluginBase::$group_info	public	property	Contains the information of the selected item in a grouped filter.
FilterPluginBase::$no_operator	public	property	Disable the possibility to use operators.	1
FilterPluginBase::$operator	public	property	Contains the operator which is used on the query.
FilterPluginBase::$value	public	property	Contains the actual value of the field,either configured in the views ui or entered in the exposed filters.
FilterPluginBase::addGroupForm	public	function	Add a new group to the exposed filter groups.
FilterPluginBase::arrayFilterZero	protected static	function	Filter by no empty values, though allow the use of (string) "0".
FilterPluginBase::buildExposedFiltersGroupForm	protected	function	Build the form to let users create the group of exposed filters.
FilterPluginBase::buildExposedForm	public	function	Render our chunk of the exposed filter form when selecting.
FilterPluginBase::buildGroupForm	public	function	Displays the Build Group form.
FilterPluginBase::buildGroupOptions	protected	function	Provide default options for exposed filters.
FilterPluginBase::buildGroupSubmit	protected	function	Save new group items, re-enumerates and remove groups marked to delete.
FilterPluginBase::buildGroupValidate	protected	function	Validate the build group options form.
FilterPluginBase::buildOptionsForm	public	function	Provide the basic form which calls through to subforms.	1
FilterPluginBase::buildValueWrapper	protected	function	Builds wrapper for value and operator forms.
FilterPluginBase::canBuildGroup	protected	function	Determine if a filter can be converted into a group.
FilterPluginBase::canExpose	public	function	Determine if a filter can be exposed.	5
FilterPluginBase::canGroup	public	function	Can this filter be used in OR groups?	1
FilterPluginBase::convertExposedInput	public	function	Transform the input from a grouped filter into a standard filter.
FilterPluginBase::exposedInfo	public	function	Tell the renderer about our exposed form. This only needs to be overridden for particularly complex forms. And maybe not even then.
FilterPluginBase::exposedTranslate	protected	function	Make some translations to a form item to make it more suitable to exposing.
FilterPluginBase::getCacheMaxAge	public	function	The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
FilterPluginBase::getCacheTags	public	function	The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags	1
FilterPluginBase::groupForm	public	function	Build a form containing a group of operator \| values to apply as a single filter.
FilterPluginBase::groupMultipleExposedInput	public	function	Returns the options available for a grouped filter that users checkboxes as widget, and therefore has to be applied several times, one per item selected.
FilterPluginBase::hasValidGroupedValue	protected	function	Determines if the given grouped filter entry has a valid value.	1
FilterPluginBase::isAGroup	public	function	Returns TRUE if the exposed filter works like a grouped filter.
FilterPluginBase::multipleExposedInput	public	function	Returns TRUE if users can select multiple groups items of a grouped exposed filter.
FilterPluginBase::operatorForm	protected	function	Options form subform for setting the operator.	5
FilterPluginBase::operatorSubmit	public	function	Perform any necessary changes to the form values prior to storage.
FilterPluginBase::operatorValidate	protected	function	Validate the operator form.
FilterPluginBase::prepareFilterSelectOptions	protected	function	Sanitizes the HTML select element's options.
FilterPluginBase::showBuildGroupButton	protected	function	Shortcut to display the build_group/hide button.
FilterPluginBase::showBuildGroupForm	public	function	Shortcut to display the exposed options form.
FilterPluginBase::showExposeButton	public	function	Shortcut to display the expose/hide button.
FilterPluginBase::showOperatorForm	public	function	Shortcut to display the operator form.
FilterPluginBase::showValueForm	protected	function	Shortcut to display the value form.
FilterPluginBase::storeExposedInput	public	function
FilterPluginBase::storeGroupInput	public	function	If set to remember exposed input in the session, store it there.
FilterPluginBase::submitOptionsForm	public	function	Simple submit handler.
FilterPluginBase::trustedCallbacks	public static	function
FilterPluginBase::validateExposeForm	public	function	Validate the options form.
FilterPluginBase::validateIdentifier	protected	function	Validates a filter identifier.
FilterPluginBase::validateOptionsForm	public	function	Simple validate handler.	1
InOperator::$valueOptions	protected	property	Stores all operations which are available on the form.
InOperator::$valueTitle	protected	property	The filter title.
InOperator::defaultExposeOptions	public	function	Provide default options for exposed filters. Overrides FilterPluginBase::defaultExposeOptions
InOperator::opEmpty	protected	function
InOperator::operatorValues	protected	function
InOperator::opSimple	protected	function		1
InOperator::reduceValueOptions	public	function	When using exposed filters, we may be required to reduce the set.
InOperator::validate	public	function	Overrides FilterPluginBase::validate
ManyToOne::$helper	public	property	Stores the Helper object which handles the many_to_one complexity.
ManyToOne::$valueFormType	protected	property	Overrides InOperator::$valueFormType
ManyToOne::ensureMyTable	public	function	Override ensureMyTable so we can control how this joins in. The operator actually has influence over joining.
ManyToOne::operators	public	function	This kind of construct makes it relatively easy for a child class to add or remove functionality by overriding this function and adding/removing items from this array. Overrides InOperator::operators	1
ManyToOne::opHelper	protected	function
TaxonomyIndexDepthQueryTrait::addSubQueryJoin	protected	function	Builds a performant depth subquery and adds it as a join to the query.
TaxonomyIndexTid::$currentUser	protected	property	The current user.
TaxonomyIndexTid::$termStorage	protected	property	The term storage.
TaxonomyIndexTid::$validated_exposed_input	public	property	Stores the exposed input for this filter.
TaxonomyIndexTid::$vocabularyStorage	protected	property	The vocabulary storage.
TaxonomyIndexTid::acceptExposedInput	public	function	Determines if the input from a filter should change the generated query. Overrides InOperator::acceptExposedInput
TaxonomyIndexTid::adminSummary	public	function	Display the filter on the administrative summary. Overrides InOperator::adminSummary
TaxonomyIndexTid::buildExposeForm	public	function	Options form subform for exposed filter options. Overrides InOperator::buildExposeForm
TaxonomyIndexTid::calculateDependencies	public	function
TaxonomyIndexTid::create	public static	function
TaxonomyIndexTid::getCacheContexts	public	function	The cache contexts associated with this object. Overrides FilterPluginBase::getCacheContexts
TaxonomyIndexTid::getValueOptions	public	function	Child classes should be used to override this function and set the 'value options', unless 'options callback' is defined as a valid function or static public method to generate these values. Overrides InOperator::getValueOptions
TaxonomyIndexTid::hasExtraOptions	public	function
TaxonomyIndexTid::init	public	function	Overrides \Drupal\views\Plugin\views\HandlerBase::init(). Overrides ManyToOne::init
TaxonomyIndexTid::validateExposed	public	function
TaxonomyIndexTid::valueForm	protected	function	Options form subform for setting options. Overrides ManyToOne::valueForm
TaxonomyIndexTid::valueSubmit	protected	function	Perform any necessary changes to the form values prior to storage. Overrides InOperator::valueSubmit
TaxonomyIndexTid::valueValidate	protected	function	Validate the options form. Overrides FilterPluginBase::valueValidate
TaxonomyIndexTid::__construct	public	function	Constructs a TaxonomyIndexTid object.
TaxonomyIndexTidDepth::buildExtraOptionsForm	public	function	Overrides TaxonomyIndexTid::buildExtraOptionsForm
TaxonomyIndexTidDepth::defineOptions	protected	function	Overrides TaxonomyIndexTid::defineOptions
TaxonomyIndexTidDepth::operatorOptions	public	function	Build strings from the operators() for 'select' options. Overrides InOperator::operatorOptions
TaxonomyIndexTidDepth::query	public	function	Add this filter to the query. Overrides InOperator::query

You are here