class views_handler_filter_term_node_tid_depth
- 3.x modules/taxonomy/views_handler_filter_term_node_tid_depth.inc views_handler_filter_term_node_tid_depth
- 2.x modules/taxonomy/views_handler_filter_term_node_tid_depth.inc views_handler_filter_term_node_tid_depth
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.
Hierarchy
- class \views_object
Expanded class hierarchy of views_handler_filter_term_node_tid_depth
Related topics
1 string reference to 'views_handler_filter_term_node_tid_depth'
- taxonomy_views_data_alter in modules/
taxonomy.views.inc - Implements hook_views_data_alter().
File
- modules/
taxonomy/ views_handler_filter_term_node_tid_depth.inc, line 16 - Definition of views_handler_filter_term_node_tid_depth.
View source
class views_handler_filter_term_node_tid_depth extends views_handler_filter_term_node_tid {
function operator_options($which = 'title') {
return array(
'or' => t('Is one of'),
);
}
function option_definition() {
$options = parent::option_definition();
$options['depth'] = array('default' => 0);
return $options;
}
function extra_options_form(&$form, &$form_state) {
parent::extra_options_form($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).'),
);
}
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 ensure_my_table() 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->table_alias = $this->relationship;
}
// If no relationship, then use the alias of the base table.
elseif (isset($this->query->table_queue[$this->query->base_table]['alias'])) {
$this->table_alias = $this->query->table_queue[$this->query->base_table]['alias'];
}
// 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);
$this->query->add_where($this->options['group'], "$this->table_alias.$this->real_field", $subquery, 'IN');
}
}
Members
Name | Modifiers | Type | Description |
---|---|---|---|
views_handler:: |
public | property | The alias of the table of this handler which is used in the query. |
views_handler:: |
function | Check whether current user has access to this handler. | |
views_handler:: |
function | Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. | |
views_handler:: |
function | Transform a string by a certain method. | |
views_handler:: |
function | Submit the exposed handler form | |
views_handler:: |
function | Perform any necessary changes to the form exposes prior to storage. There is no need for this function to actually store the data. | |
views_handler:: |
function | Provide defaults for the handler. | |
views_handler:: |
function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | |
views_handler:: |
function | Validate the options form. | |
views_handler:: |
function | Shortcut to get a handler's raw field value. | |
views_handler:: |
function | Get the join object that should be used for this handler. | |
views_handler:: |
function | Provide a form for aggregation settings. | |
views_handler:: |
function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | |
views_handler:: |
function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
views_handler:: |
function | Determine if the argument needs a style plugin. | |
views_handler:: |
function | Provides a unique placeholders for handlers. | |
views_handler:: |
function | Run after the view is executed, before the result is cached. | |
views_handler:: |
function | Run before the view is built. | |
views_handler:: |
function | Sanitize the value for output. | |
views_handler:: |
function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
views_handler:: |
function | Shortcut to display the exposed options form. | |
views_handler:: |
function | Return a string representing this handler's name in the UI. | |
views_handler:: |
function | Provides the handler some groupby. | |
views_handler_filter:: |
function | Build the form to let users create the group of exposed filters. This form is displayed when users click on button 'Build group' | |
views_handler_filter:: |
function | Provide default options for exposed filters. | |
views_handler_filter:: |
function | Save new group items, re-enumerates and remove groups marked to delete. | |
views_handler_filter:: |
function | Validate the build group options form. | |
views_handler_filter:: |
function | Determine if a filter can be converted into a group. Only exposed filters with operators available can be converted into groups. | |
views_handler_filter:: |
function |
Determine if a filter can be exposed. Overrides views_handler:: |
|
views_handler_filter:: |
function | Can this filter be used in OR groups? | |
views_handler_filter:: |
function | ||
views_handler_filter:: |
function |
Render our chunk of the exposed filter form when selecting Overrides views_handler:: |
|
views_handler_filter:: |
function |
Tell the renderer about our exposed form. This only needs to be
overridden for particularly complex forms. And maybe not even then. Overrides views_handler:: |
|
views_handler_filter:: |
function | Make some translations to a form item to make it more suitable to exposing. | |
views_handler_filter:: |
function |
Validate the options form. Overrides views_handler:: |
|
views_handler_filter:: |
function | Build a form containing a group of operator | values to apply as a single filter. | |
views_handler_filter:: |
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. | |
views_handler_filter:: |
function |
Returns TRUE if the exposed filter works like a grouped filter. Overrides views_handler:: |
|
views_handler_filter:: |
function |
Returns TRUE if users can select multiple groups items of a
grouped exposed filter. Overrides views_handler:: |
|
views_handler_filter:: |
function | Options form subform for setting the operator. | |
views_handler_filter:: |
function | Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. | |
views_handler_filter:: |
function | Validate the operator form. | |
views_handler_filter:: |
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 views_handler:: |
|
views_handler_filter:: |
function |
Simple submit handler Overrides views_handler:: |
|
views_handler_filter:: |
function |
Simple validate handler Overrides views_handler:: |
|
views_handler_filter:: |
function | Sanitizes the HTML select element's options. | |
views_handler_filter:: |
function | Shortcut to display the build_group/hide button. | |
views_handler_filter:: |
function | Shortcut to display the exposed options form. | |
views_handler_filter:: |
function |
Shortcut to display the expose/hide button. Overrides views_handler:: |
|
views_handler_filter:: |
function | Shortcut to display the operator form. | |
views_handler_filter:: |
function | Shortcut to display the value form. | |
views_handler_filter:: |
function |
If set to remember exposed input in the session, store it there. Overrides views_handler:: |
|
views_handler_filter:: |
function | If set to remember exposed input in the session, store it there. This function is similar to store_exposed_input but modified to work properly when the filter is a group. | |
views_handler_filter_in_operator:: |
function |
Views handlers use a special construct function so that we can more
easily construct them with variable arguments. Overrides views_object:: |
|
views_handler_filter_in_operator:: |
function |
Provide default options for exposed filters. Overrides views_handler_filter:: |
|
views_handler_filter_in_operator:: |
function | ||
views_handler_filter_in_operator:: |
function | ||
views_handler_filter_in_operator:: |
function | ||
views_handler_filter_in_operator:: |
function | When using exposed filters, we may be required to reduce the set. | |
views_handler_filter_in_operator:: |
function |
Validates the handler against the complete View. Overrides views_handler:: |
|
views_handler_filter_many_to_one:: |
function |
Override ensure_my_table so we can control how this joins in.
The operator actually has influence over joining. Overrides views_handler:: |
|
views_handler_filter_many_to_one:: |
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 views_handler_filter_in_operator:: |
|
views_handler_filter_many_to_one:: |
function | ||
views_handler_filter_term_node_tid:: |
function |
Check to see if input from the exposed filters should change
the behavior of this filter. Overrides views_handler_filter_in_operator:: |
|
views_handler_filter_term_node_tid:: |
function |
Display the filter on the administrative summary Overrides views_handler_filter_in_operator:: |
|
views_handler_filter_term_node_tid:: |
function |
Validate the exposed handler form Overrides views_handler:: |
|
views_handler_filter_term_node_tid:: |
function |
Options form subform for exposed filter options. Overrides views_handler_filter_in_operator:: |
|
views_handler_filter_term_node_tid:: |
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 views_handler_filter_in_operator:: |
|
views_handler_filter_term_node_tid:: |
function |
If a handler has 'extra options' it will get a little settings widget and
another form called extra_options. Overrides views_handler:: |
|
views_handler_filter_term_node_tid:: |
function |
Provide some extra help to get the operator/value easier to use. Overrides views_handler_filter_many_to_one:: |
|
views_handler_filter_term_node_tid:: |
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. | |
views_handler_filter_term_node_tid:: |
function |
Options form subform for setting options. Overrides views_handler_filter_many_to_one:: |
|
views_handler_filter_term_node_tid:: |
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 views_handler_filter_in_operator:: |
|
views_handler_filter_term_node_tid:: |
function |
Validate the options form. Overrides views_handler_filter:: |
|
views_handler_filter_term_node_tid_depth:: |
function |
Provide a form for setting options. Overrides views_handler_filter_term_node_tid:: |
|
views_handler_filter_term_node_tid_depth:: |
function |
Build strings from the operators() for 'select' options Overrides views_handler_filter_in_operator:: |
|
views_handler_filter_term_node_tid_depth:: |
function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides views_handler_filter_term_node_tid:: |
|
views_handler_filter_term_node_tid_depth:: |
function |
Add this filter to the query. Overrides views_handler_filter_in_operator:: |
|
views_object:: |
function | ||
views_object:: |
function | ||
views_object:: |
function | ||
views_object:: |
function | Always exports the option, regardless of the default value. | |
views_object:: |
function | Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility. | |
views_object:: |
function | Set default options. For backward compatibility, it sends the options array; this is a feature that will likely disappear at some point. | |
views_object:: |
function | Let the handler know what its full definition is. | |
views_object:: |
function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
views_object:: |
function | Unpack a single option definition. | |
views_object:: |
function | Unpacks each handler to store translatable texts. | |
views_object:: |
function |