class views_handler_argument_term_node_tid_depth
- 3.x modules/taxonomy/views_handler_argument_term_node_tid_depth.inc views_handler_argument_term_node_tid_depth
- 2.x modules/taxonomy/views_handler_argument_term_node_tid_depth.inc views_handler_argument_term_node_tid_depth
Argument 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
- class \views_handler
Expanded class hierarchy of views_handler_argument_term_node_tid_depth
Related topics
1 string reference to 'views_handler_argument_term_node_tid_depth'
- taxonomy_views_data_alter in modules/
taxonomy.views.inc - Implements hook_views_data_alter().
File
- modules/
taxonomy/ views_handler_argument_term_node_tid_depth.inc, line 16 - Definition of views_handler_argument_term_node_tid_depth.
View source
class views_handler_argument_term_node_tid_depth extends views_handler_argument {
function option_definition() {
$options = parent::option_definition();
$options['depth'] = array('default' => 0);
$options['break_phrase'] = array('default' => FALSE, 'bool' => TRUE);
$options['set_breadcrumb'] = array('default' => FALSE, 'bool' => TRUE);
$options['use_taxonomy_term_path'] = array('default' => FALSE, 'bool' => TRUE);
return $options;
}
function 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).'),
);
$form['break_phrase'] = array(
'#type' => 'checkbox',
'#title' => t('Allow multiple values'),
'#description' => 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']),
);
$form['set_breadcrumb'] = array(
'#type' => 'checkbox',
'#title' => t("Set the breadcrumb for the term parents"),
'#description' => t('If selected, the breadcrumb trail will include all parent terms, each one linking to this view. Note that this only works if just one term was received.'),
'#default_value' => !empty($this->options['set_breadcrumb']),
);
$form['use_taxonomy_term_path'] = array(
'#type' => 'checkbox',
'#title' => t("Use Drupal's taxonomy term path to create breadcrumb links"),
'#description' => t('If selected, the links in the breadcrumb trail will be created using the standard drupal method instead of the custom views method. This is useful if you are using modules like taxonomy redirect to modify your taxonomy term links.'),
'#default_value' => !empty($this->options['use_taxonomy_term_path']),
'#dependency' => array('edit-options-set-breadcrumb' => array(TRUE)),
);
parent::options_form($form, $form_state);
}
function set_breadcrumb(&$breadcrumb) {
if (empty($this->options['set_breadcrumb']) || !is_numeric($this->argument)) {
return;
}
return views_taxonomy_set_breadcrumb($breadcrumb, $this);
}
/**
* Override default_actions() to remove summary actions.
*/
function default_actions($which = NULL) {
if ($which) {
if (in_array($which, array('ignore', 'not found', 'empty', 'default'))) {
return parent::default_actions($which);
}
return;
}
$actions = parent::default_actions();
unset($actions['summary asc']);
unset($actions['summary desc']);
unset($actions['summary asc by count']);
unset($actions['summary desc by count']);
return $actions;
}
function query($group_by = FALSE) {
$this->ensure_my_table();
if (!empty($this->options['break_phrase'])) {
$tids = new stdClass();
$tids->value = $this->argument;
$tids = views_break_phrase($this->argument, $tids);
if ($tids->value == array(-1)) {
return FALSE;
}
if (count($tids->value) > 1) {
$operator = 'IN';
}
else {
$operator = '=';
}
$tids = $tids->value;
}
else {
$operator = "=";
$tids = $this->argument;
}
// Now build the subqueries.
$subquery = db_select('taxonomy_index', 'tn');
$subquery->addField('tn', 'nid');
$where = db_or()->condition('tn.tid', $tids, $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", $tids, $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", $tids, $operator);
$last = "th$count";
}
}
$subquery->condition($where);
$this->query->add_where(0, "$this->table_alias.$this->real_field", $subquery, 'IN');
}
function title() {
$term = taxonomy_term_load($this->argument);
if (!empty($term)) {
return check_plain($term->name);
}
// TODO review text
return t('No name');
}
}
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 | Take input from exposed handlers and assign to this handler, if necessary. | |
views_handler:: |
function | Check whether current user has access to this handler. | |
views_handler:: |
function | Provide text for the administrative summary | |
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 | Determine if a handler can be exposed. | |
views_handler:: |
function | Transform a string by a certain method. | |
views_handler:: |
function | Ensure the main table for this handler is in the query. This is used a lot. | |
views_handler:: |
function | Render our chunk of the exposed handler form when selecting | |
views_handler:: |
function | Get information about the exposed form for the form renderer. | |
views_handler:: |
function | Submit the exposed handler form | |
views_handler:: |
function | Validate the exposed handler form | |
views_handler:: |
function | Form for exposed handler options. | |
views_handler:: |
function | Set new exposed option defaults when exposed setting is flipped on. | |
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 | Validate the options form. | |
views_handler:: |
function | Provide defaults for the handler. | |
views_handler:: |
function | Provide a form for setting options. | |
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 | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | |
views_handler:: |
function | Returns TRUE if the exposed filter works like a grouped filter. | |
views_handler:: |
function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
views_handler:: |
function | Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. | |
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 expose/hide button. | |
views_handler:: |
function | Shortcut to display the exposed options form. | |
views_handler:: |
function | If set to remember exposed input in the session, store it there. | |
views_handler:: |
function | Return a string representing this handler's name in the UI. | |
views_handler:: |
function | Provides the handler some groupby. | |
views_handler:: |
function | Validates the handler against the complete View. | |
views_handler_argument:: |
function |
Constructor Overrides views_object:: |
|
views_handler_argument:: |
function | Default action: access denied. | |
views_handler_argument:: |
function | Handle the default action, which means our argument wasn't present. | |
views_handler_argument:: |
function | Provide a form for selecting the default argument when the default action is set to provide default argument. | |
views_handler_argument:: |
function | This just returns true. The view argument builder will know where to find the argument from. | |
views_handler_argument:: |
function | Default action: empty | |
views_handler_argument:: |
function | Default action: ignore. | |
views_handler_argument:: |
function | Default action: not found. | |
views_handler_argument:: |
function | Default action: summary. | |
views_handler_argument:: |
function | Provide a form for selecting further summary options when the default action is set to display one. | |
views_handler_argument:: |
function | ||
views_handler_argument:: |
function | Generic plugin export handler. | |
views_handler_argument:: |
function | Export handler for summary export. | |
views_handler_argument:: |
function | Export handler for validation export. | |
views_handler_argument:: |
function | Get a default argument, if available. | |
views_handler_argument:: |
function | Get the display or row plugin, if it exists. | |
views_handler_argument:: |
function | Return a description of how the argument would normally be sorted. | |
views_handler_argument:: |
function | Called by the view object to get the title. This may be set by a validator so we don't necessarily call through to title(). | |
views_handler_argument:: |
function | Get the value of this argument. | |
views_handler_argument:: |
function | Determine if the argument is set to provide a default argument. | |
views_handler_argument:: |
function |
init the handler with necessary data. Overrides views_handler:: |
|
views_handler_argument:: |
function | ||
views_handler_argument:: |
function |
Determine if the argument needs a style plugin. Overrides views_handler:: |
|
views_handler_argument:: |
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:: |
|
views_handler_argument:: |
function |
Validate the options form. Overrides views_handler:: |
|
views_handler_argument:: |
function | Process the summary arguments for display. | |
views_handler_argument:: |
function | Set the input for this argument | |
views_handler_argument:: |
function | Provide the argument to use to link from the summary to the next level; this will be called once per row of a summary, and used as part of $view->get_url(). | |
views_handler_argument:: |
function | Some basic summary behavior that doesn't need to be repeated as much as code that goes into summary_query() | |
views_handler_argument:: |
function | Provides the name to use for the summary. By default this is just the name field. | |
views_handler_argument:: |
function | Add the name field, which is the field displayed in summary queries. This is often used when the argument is numeric. | |
views_handler_argument:: |
function | Build the info for the summary query. | |
views_handler_argument:: |
function | Sorts the summary based upon the user's selection. The base variant of this is usually adequte. | |
views_handler_argument:: |
function | Determine if the argument can generate a breadcrumb | |
views_handler_argument:: |
function | Validate that this argument works. By default, all arguments are valid. | |
views_handler_argument:: |
function | Called by the menu system to validate an argument. | |
views_handler_argument:: |
function | Provide a basic argument validation. | |
views_handler_argument:: |
function | How to act if validation failes | |
views_handler_argument_term_node_tid_depth:: |
function |
Override default_actions() to remove summary actions. Overrides views_handler_argument:: |
|
views_handler_argument_term_node_tid_depth:: |
function |
Build the options form. Overrides views_handler_argument:: |
|
views_handler_argument_term_node_tid_depth:: |
function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides views_handler_argument:: |
|
views_handler_argument_term_node_tid_depth:: |
function |
Set up the query for this argument. Overrides views_handler_argument:: |
|
views_handler_argument_term_node_tid_depth:: |
function |
Give an argument the opportunity to modify the breadcrumb, if it wants.
This only gets called on displays where a breadcrumb is actually used. Overrides views_handler_argument:: |
|
views_handler_argument_term_node_tid_depth:: |
function |
Get the title this argument will assign the view, given the argument. Overrides views_handler_argument:: |
|
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 |