class nat_handler_argument_term_node_tid_depth in Node Auto Term [NAT] 7
Same name and namespace in other branches
- 6.2 includes/nat_handler_argument_term_node_tid_depth.inc \nat_handler_argument_term_node_tid_depth
- 6 includes/nat_handler_argument_term_node_tid_depth.inc \nat_handler_argument_term_node_tid_depth
- 7.2 includes/nat_handler_argument_term_node_tid_depth.inc \nat_handler_argument_term_node_tid_depth
Argument handler for NAT terms over NAT nid 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 nat_handler_argument_term_node_tid_depth
1 string reference to 'nat_handler_argument_term_node_tid_depth'
- nat_views_data_alter in includes/
nat.views.inc - Implements hook_views_data_alter().
File
- includes/
nat_handler_argument_term_node_tid_depth.inc, line 15 - NAT (Node Auto Term) nid views argument with depth handler.
View source
class nat_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,
);
$options['set_breadcrumb'] = array(
'default' => FALSE,
);
return $options;
}
function options_form(&$form, &$form_state) {
parent::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 terms per argument'),
'#description' => t('If selected, users can enter multiple arguments in the form of 1+2+3. Due to the number of JOINs it would require, AND will be treated as OR with this argument.'),
'#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']),
);
}
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']);
return $actions;
}
function query() {
$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 == -1) {
return FALSE;
}
if (count($tids->value) > 1) {
$placeholder = " IN (" . implode(', ', array_fill(0, sizeof($tids->value), '%d')) . ")";
}
else {
$placeholder = " = %d";
}
foreach ($tids->value as $tid) {
$nat_tid = nat_get_term($tid);
$nat_tids[] = $nat_tid->tid;
}
$tids = $nat_tids;
}
else {
$placeholder = "= %d";
$tids = array(
$this->argument,
);
$nat_tid = nat_get_term($this->argument);
$tids = array(
$nat_tid->tid,
);
}
$subquery = "\n SELECT tn.vid FROM {taxonomy_term_data} tn\n";
$where = " WHERE tn.tid {$placeholder}\n";
$args = $tids;
$last = "tn";
if ($this->options['depth'] > 0) {
$subquery .= " LEFT JOIN {taxonomy_term_hierarchy} th ON th.tid = tn.tid\n";
$last = "th";
foreach (range(1, abs($this->options['depth'])) as $count) {
$subquery .= " LEFT JOIN {taxonomy_term_hierarchy} th{$count} ON {$last}.parent = th{$count}.tid\n";
$where .= " OR th{$count}.tid {$placeholder}\n";
$args = array_merge($args, $tids);
$last = "th{$count}";
}
}
elseif ($this->options['depth'] < 0) {
foreach (range(1, abs($this->options['depth'])) as $count) {
$subquery .= " LEFT JOIN {taxonomy_term_hierarchy} th{$count} ON {$last}.tid = th{$count}.parent\n";
$where .= " OR th{$count}.tid {$placeholder}\n";
$args = array_merge($args, $tids);
$last = "th{$count}";
}
}
$this->query
->add_where(0, "{$this->table_alias}.{$this->real_field} IN ({$subquery}{$where} )", $args);
}
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 | Overrides |
---|---|---|---|---|
nat_handler_argument_term_node_tid_depth:: |
function |
Override default_actions() to remove summary actions. Overrides views_handler_argument:: |
||
nat_handler_argument_term_node_tid_depth:: |
function |
Build the options form. Overrides views_handler_argument:: |
||
nat_handler_argument_term_node_tid_depth:: |
function |
Information about options for all kinds of purposes will be held here. Overrides views_handler_argument:: |
||
nat_handler_argument_term_node_tid_depth:: |
function |
Set up the query for this argument. Overrides views_handler_argument:: |
||
nat_handler_argument_term_node_tid_depth:: |
function |
Give an argument the opportunity to modify the breadcrumb, if it wants. Overrides views_handler_argument:: |
||
nat_handler_argument_term_node_tid_depth:: |
function |
Get the title this argument will assign the view, given the argument. Overrides views_handler_argument:: |
||
views_handler:: |
public | property | The type of the handler, for example filter/footer/field. | |
views_handler:: |
public | property | Where the $query object will reside:. | 1 |
views_handler:: |
public | property | The actual field in the database table, maybe different on other kind of query plugins/special handlers. | |
views_handler:: |
public | property | The relationship used for this field. | |
views_handler:: |
public | property | The alias of the table of this handler which is used in the query. | |
views_handler:: |
public | property |
The top object of a view. Overrides views_object:: |
|
views_handler:: |
public | function | Take input from exposed handlers and assign to this handler, if necessary. | 1 |
views_handler:: |
public | function | Check whether current user has access to this handler. | 10 |
views_handler:: |
public | function | Provide text for the administrative summary. | 4 |
views_handler:: |
public | function | Determine if the handler is considered 'broken'. | 6 |
views_handler:: |
public | function | Determine if a handler can be exposed. | 2 |
views_handler:: |
public | function | Transform a string by a certain method. | |
views_handler:: |
public | function | Ensure the main table for this handler is in the query. This is used a lot. | 8 |
views_handler:: |
public | function | Render our chunk of the exposed handler form when selecting. | 1 |
views_handler:: |
public | function | Get information about the exposed form for the form renderer. | 1 |
views_handler:: |
public | function | Submit the exposed handler form. | |
views_handler:: |
public | function | Validate the exposed handler form. | 4 |
views_handler:: |
public | function | Form for exposed handler options. | 2 |
views_handler:: |
public | function | Set new exposed option defaults when exposed setting is flipped on. | 2 |
views_handler:: |
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. | |
views_handler:: |
public | function | Validate the options form. | 1 |
views_handler:: |
public | function | Provide defaults for the handler. | |
views_handler:: |
public | function | Provide a form for setting options. | 1 |
views_handler:: |
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. | |
views_handler:: |
public | function | Validate the options form. | |
views_handler:: |
public | function | Shortcut to get a handler's raw field value. | |
views_handler:: |
public | function | Get the join object that should be used for this handler. | |
views_handler:: |
public | function | Provide a form for aggregation settings. | 1 |
views_handler:: |
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 |
views_handler:: |
public | function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | 1 |
views_handler:: |
public | function | Returns TRUE if the exposed filter works like a grouped filter. | 1 |
views_handler:: |
public | function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
views_handler:: |
public | function | Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. | 1 |
views_handler:: |
public | function | Provides a unique placeholders for handlers. | |
views_handler:: |
public | function | Run after the view is executed, before the result is cached. | 1 |
views_handler:: |
public | function | Run before the view is built. | 1 |
views_handler:: |
public | function | Sanitize the value for output. | |
views_handler:: |
public | function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
views_handler:: |
public | function | Shortcut to display the expose/hide button. | 2 |
views_handler:: |
public | function | Shortcut to display the exposed options form. | |
views_handler:: |
public | function | If set to remember exposed input in the session, store it there. | 1 |
views_handler:: |
public | function | Return a string representing this handler's name in the UI. | 9 |
views_handler:: |
public | function | Provides the handler some groupby. | 2 |
views_handler:: |
public | function | Validates the handler against the complete View. | 1 |
views_handler_argument:: |
public | property | ||
views_handler_argument:: |
public | property | The field to use for the name to use in the summary. | |
views_handler_argument:: |
public | property | The table to use for the name, if not the same table as the argument. | |
views_handler_argument:: |
public | property | ||
views_handler_argument:: |
public | property | 1 | |
views_handler_argument:: |
public | function |
Views handlers use a special construct function. Overrides views_object:: |
5 |
views_handler_argument:: |
public | function | Default action: access denied. | |
views_handler_argument:: |
public | function | Handle the default action, which means our argument wasn't present. | |
views_handler_argument:: |
public | function | Provide a form for selecting the default argument. | 1 |
views_handler_argument:: |
public | function | This just returns true. | |
views_handler_argument:: |
public | function | Default action: empty. | |
views_handler_argument:: |
public | function | Default action: ignore. | |
views_handler_argument:: |
public | function | Default action: not found. | |
views_handler_argument:: |
public | function | Default action: summary. | |
views_handler_argument:: |
public | function | Form for selecting further summary options. | |
views_handler_argument:: |
public | function | Work out which title to use. | |
views_handler_argument:: |
public | function | Generic plugin export handler. | 1 |
views_handler_argument:: |
public | function | Export handler for summary export. | |
views_handler_argument:: |
public | function | Export handler for validation export. | |
views_handler_argument:: |
public | function | Get a default argument, if available. | 1 |
views_handler_argument:: |
public | function | Get the display or row plugin, if it exists. | |
views_handler_argument:: |
public | function | Return a description of how the argument would normally be sorted. | 5 |
views_handler_argument:: |
public | function | Called by the view object to get the title. | |
views_handler_argument:: |
public | function | Get the value of this argument. | |
views_handler_argument:: |
public | function | Determine if the argument is set to provide a default argument. | |
views_handler_argument:: |
public | function |
Init the handler with necessary data. Overrides views_handler:: |
3 |
views_handler_argument:: |
public | function | ||
views_handler_argument:: |
public | function |
Determine if the argument needs a style plugin. Overrides views_handler:: |
|
views_handler_argument:: |
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. Overrides views_handler:: |
|
views_handler_argument:: |
public | function |
Validate the options form. Overrides views_handler:: |
|
views_handler_argument:: |
public | function | Process the summary arguments for display. | |
views_handler_argument:: |
public | function | Set the input for this argument. | |
views_handler_argument:: |
public | function | Provide the argument to use to link from the summary to the next level. | 4 |
views_handler_argument:: |
public | function | Some basic summary behavior. | |
views_handler_argument:: |
public | function | Provides the name to use for the summary. | 10 |
views_handler_argument:: |
public | function | Add the name field, which is the field displayed in summary queries. | |
views_handler_argument:: |
public | function | Build the info for the summary query. | 3 |
views_handler_argument:: |
public | function | Sorts the summary based upon the user's selection. | |
views_handler_argument:: |
public | function | Determine if the argument can generate a breadcrumb. | |
views_handler_argument:: |
public | function | Validate that this argument works. By default, all arguments are valid. | |
views_handler_argument:: |
public | function | Called by the menu system to validate an argument. | |
views_handler_argument:: |
public | function | Provide a basic argument validation. | 1 |
views_handler_argument:: |
public | function | How to act if validation fails. | |
views_object:: |
public | property | Handler's definition. | |
views_object:: |
public | property | Except for displays, options for the object will be held here. | 1 |
views_object:: |
function | Collect this handler's option definition and alter them, ready for use. | ||
views_object:: |
public | function | Destructor. | 2 |
views_object:: |
public | function | 1 | |
views_object:: |
public | function | ||
views_object:: |
public | function | Always exports the option, regardless of the default value. | |
views_object:: |
public | function | Set default options on this object. | 1 |
views_object:: |
public | function | Set default options. | |
views_object:: |
public | function | Let the handler know what its full definition is. | |
views_object:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
views_object:: |
public | function | Unpack a single option definition. | |
views_object:: |
public | function | Unpacks each handler to store translatable texts. | |
views_object:: |
public | function |