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(
id = "taxonomy_index_tid_depth",
module = "taxonomy"
)
Expanded class hierarchy of TaxonomyIndexTidDepth
class TaxonomyIndexTidDepth extends TaxonomyIndexTid {
function operator_options($which = 'title') {
return array(
'or' => t('Is one of'),
);
}
protected function defineOptions() {
$options = parent::defineOptions();
$options['depth'] = array(
'default' => 0,
);
return $options;
}
public function buildExtraOptionsForm(&$form, &$form_state) {
parent::buildExtraOptionsForm($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).'),
);
}
public function query() {
// 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')) . ")";
}
// The normal use of ensureMyTable() here breaks Views.
// 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)) {
$this->tableAlias = $this->relationship;
}
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'];
}
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);
$this->query
->add_where($this->options['group'], "{$this->tableAlias}.{$this->realField}", $subquery, 'IN');
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
TaxonomyIndexTidDepth:: |
public | function |
Add this filter to the query. Overrides InOperator:: |
|
TaxonomyIndexTidDepth:: |
function |
Build strings from the operators() for 'select' options Overrides InOperator:: |
||
TaxonomyIndexTidDepth:: |
protected | function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides TaxonomyIndexTid:: |
|
TaxonomyIndexTidDepth:: |
public | function |
Provide a form for setting options. Overrides TaxonomyIndexTid:: |
|
TaxonomyIndexTid:: |
function |
Validate the options form. Overrides FilterPluginBase:: |
||
TaxonomyIndexTid:: |
function |
Perform any necessary changes to the form values prior to storage.
There is no need for this function to actually store the data. Overrides InOperator:: |
||
TaxonomyIndexTid:: |
function |
Options form subform for setting options. Overrides ManyToOne:: |
||
TaxonomyIndexTid:: |
function | Validate the user string. Since this can come from either the form or the exposed filter, this is abstracted out a bit so it can handle the multiple input sources. | ||
TaxonomyIndexTid:: |
public | function |
Validate the exposed handler form Overrides HandlerBase:: |
|
TaxonomyIndexTid:: |
public | function |
Overrides Drupal\views\Plugin\views\filter\FilterPluginBase::init(). Overrides ManyToOne:: |
|
TaxonomyIndexTid:: |
public | function |
If a handler has 'extra options' it will get a little settings widget and
another form called extra_options. Overrides HandlerBase:: |
|
TaxonomyIndexTid:: |
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:: |
||
TaxonomyIndexTid:: |
public | function |
Options form subform for exposed filter options. Overrides InOperator:: |
|
TaxonomyIndexTid:: |
public | function |
Display the filter on the administrative summary Overrides InOperator:: |
|
TaxonomyIndexTid:: |
public | function |
Check to see if input from the exposed filters should change
the behavior of this filter. Overrides InOperator:: |
|
TaxonomyIndexTid:: |
property | |||
PluginBase:: |
public | function | Returns the usesOptions property. | 8 |
PluginBase:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
PluginBase:: |
public | function | Provide a full list of possible theme templates used by this style. | 1 |
PluginBase:: |
public | function | Returns the summary of the settings in the display. | 6 |
PluginBase:: |
protected | function | ||
PluginBase:: |
public | function | Return the human readable name of the display. | |
PluginBase:: |
public | function | Returns a string with any core tokens replaced. | |
PluginBase:: |
public | function | Adds elements for available core tokens to a form. | |
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getPluginId(). Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Implements Drupal\Component\Plugin\PluginInterface::getDefinition(). Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Returns an array of available token replacements. | |
PluginBase:: |
public | function | Clears a plugin. | 2 |
PluginBase:: |
public | function | Provide a list of additional theme functions for the theme information page | |
PluginBase:: |
public | property | The top object of a view. | 1 |
PluginBase:: |
protected | property | Denotes whether the plugin has an additional options form. | 8 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
public | property | Options for this plugin will be held here. | |
PluginBase:: |
public | property | The display object this plugin is for. | |
PluginBase:: |
protected | property | The discovery object. | |
PluginBase:: |
public | property | Plugins's definition | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
ManyToOne:: |
function | |||
ManyToOne:: |
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:: |
1 | |
ManyToOne:: |
public | function |
Override ensureMyTable so we can control how this joins in.
The operator actually has influence over joining. Overrides HandlerBase:: |
|
ManyToOne:: |
property |
Overrides InOperator:: |
||
ManyToOne:: |
property | Stores the Helper object which handles the many_to_one complexity. | ||
InOperator:: |
public | function |
Validates the handler against the complete View. Overrides HandlerBase:: |
|
InOperator:: |
function | When using exposed filters, we may be required to reduce the set. | ||
InOperator:: |
function | |||
InOperator:: |
function | |||
InOperator:: |
function | |||
InOperator:: |
public | function |
Provide default options for exposed filters. Overrides FilterPluginBase:: |
|
InOperator:: |
property | Stores all operations which are available on the form. | ||
HandlerBase:: |
public | function |
Constructs a Handler object. Overrides PluginBase:: |
|
HandlerBase:: |
public | function | Validate the options form. | |
HandlerBase:: |
public | function | Provides the handler some groupby. | 2 |
HandlerBase:: |
public | function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | 1 |
HandlerBase:: |
public | function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | |
HandlerBase:: |
public | function | Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data. | |
HandlerBase:: |
public | function | Submit the exposed handler form | |
HandlerBase:: |
public | function | Shortcut to display the exposed options form. | |
HandlerBase:: |
public | function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
HandlerBase:: |
protected | function | Sanitize the value for output. | |
HandlerBase:: |
public | function | Run before the view is built. | 1 |
HandlerBase:: |
public | function | Run after the view is executed, before the result is cached. | |
HandlerBase:: |
protected | function | Provides a unique placeholders for handlers. | |
HandlerBase:: |
public | function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
HandlerBase:: |
public static | function | Figure out what timezone we're in; needed for some date manipulations. | |
HandlerBase:: |
public static | function | Fetches a handler to join one table to a primary table from the data cache. | |
HandlerBase:: |
public | function | Creates cross-database SQL date formatting. | |
HandlerBase:: |
public | function | Creates cross-database SQL dates. | |
HandlerBase:: |
public | function | Get the join object that should be used for this handler. | |
HandlerBase:: |
public | function | Shortcut to get a handler's raw field value. | |
HandlerBase:: |
public | function | Determines the entity type used by this handler. | |
HandlerBase:: |
public | function | Provide defaults for the handler. | |
HandlerBase:: |
protected | function | Transform a string by a certain method. | |
HandlerBase:: |
public | function | Provide a form for aggregation settings. | 1 |
HandlerBase:: |
public | function | Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. | 6 |
HandlerBase:: |
public static | function | Breaks x,y,z and x+y+z into an array. Works for strings. | |
HandlerBase:: |
public static | function | Breaks x,y,z and x+y+z into an array. Numeric only. | |
HandlerBase:: |
public | function | Return a string representing this handler's name in the UI. | 9 |
HandlerBase:: |
public | function | Check whether current user has access to this handler. | 6 |
HandlerBase:: |
public | property | The alias of the table of this handler which is used in the query. | |
HandlerBase:: |
public | property | The table this handler is attached to. | |
HandlerBase:: |
public | property | The relationship used for this field. | |
HandlerBase:: |
public | property | The actual field in the database table, maybe different on other kind of query plugins/special handlers. | |
HandlerBase:: |
public | property | Where the $query object will reside: | 1 |
HandlerBase:: |
public | property | With field you can override the realField if the real field is not set. | |
HandlerBase:: |
public | property | When a table has been moved this property is set. | |
HandlerBase:: |
public | property | When a field has been moved this property is set. | |
FilterPluginBase:: |
public | function |
Simple validate handler Overrides HandlerBase:: |
1 |
FilterPluginBase:: |
public | function |
Validate the options form. Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function |
Simple submit handler Overrides HandlerBase:: |
|
FilterPluginBase:: |
function | If set to remember exposed input in the session, store it there. This function is similar to storeExposedInput but modified to work properly when the filter is a group. | ||
FilterPluginBase:: |
public | function |
If set to remember exposed input in the session, store it there. Overrides HandlerBase:: |
|
FilterPluginBase:: |
function | Shortcut to display the value form. | ||
FilterPluginBase:: |
function | Shortcut to display the operator form. | ||
FilterPluginBase:: |
function | Shortcut to display the exposed options form. | ||
FilterPluginBase:: |
function | Shortcut to display the build_group/hide button. | ||
FilterPluginBase:: |
public | function |
Shortcut to display the expose/hide button. Overrides HandlerBase:: |
|
FilterPluginBase:: |
function | Sanitizes the HTML select element's options. | ||
FilterPluginBase:: |
function | Validate the operator form. | ||
FilterPluginBase:: |
function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | ||
FilterPluginBase:: |
function | Options form subform for setting the operator. | 4 | |
FilterPluginBase:: |
public | function |
Returns TRUE if users can select multiple groups items of a
grouped exposed filter. Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function |
Returns TRUE if the exposed filter works like a grouped filter. Overrides HandlerBase:: |
|
FilterPluginBase:: |
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:: |
function | Build a form containing a group of operator | values to apply as a single filter. | ||
FilterPluginBase:: |
function | Make some translations to a form item to make it more suitable to exposing. | ||
FilterPluginBase:: |
public | function |
Tell the renderer about our exposed form. This only needs to be
overridden for particularly complex forms. And maybe not even then. Overrides HandlerBase:: |
|
FilterPluginBase:: |
function | |||
FilterPluginBase:: |
function | Can this filter be used in OR groups? | 1 | |
FilterPluginBase:: |
function | Determine if a filter can be converted into a group. Only exposed filters with operators available can be converted into groups. | ||
FilterPluginBase:: |
public | function |
Determine if a filter can be exposed. Overrides HandlerBase:: |
2 |
FilterPluginBase:: |
function | Validate the build group options form. | 1 | |
FilterPluginBase:: |
function | Save new group items, re-enumerates and remove groups marked to delete. | ||
FilterPluginBase:: |
function | Provide default options for exposed filters. | ||
FilterPluginBase:: |
function | Build the form to let users create the group of exposed filters. This form is displayed when users click on button 'Build group' | ||
FilterPluginBase:: |
public | function |
Provide the basic form which calls through to subforms.
If overridden, it is best to call through to the parent,
or to at least make sure all of the functions in this form
are called. Overrides HandlerBase:: |
3 |
FilterPluginBase:: |
public | function |
Render our chunk of the exposed filter form when selecting Overrides HandlerBase:: |
|
FilterPluginBase:: |
property | Contains the actual value of the field,either configured in the views ui or entered in the exposed filters. | ||
FilterPluginBase:: |
property | Contains the operator which is used on the query. | ||
FilterPluginBase:: |
property | Disable the possibility to use operators. | 2 | |
FilterPluginBase:: |
property | Contains the information of the selected item in a gruped filter. | ||
FilterPluginBase:: |
property | Disable the possibility to allow a exposed input to be optional. | ||
FilterPluginBase:: |
property | Disable the possibility to force a single value. | 6 |