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.
@PluginID("taxonomy_index_tid_depth");
Expanded class hierarchy of IndexTidDepth
class IndexTidDepth extends ArgumentPluginBase {
protected function defineOptions() {
$options = parent::defineOptions();
$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;
}
public function buildOptionsForm(&$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']),
'#states' => array(
'visible' => array(
':input[name="options[set_breadcrumb]"]' => array(
'checked' => TRUE,
),
),
),
);
parent::buildOptionsForm($form, $form_state);
}
public function setBreadcrumb(&$breadcrumb) {
if (empty($this->options['set_breadcrumb']) || !is_numeric($this->argument)) {
return;
}
return views_taxonomy_set_breadcrumb($breadcrumb, $this);
}
/**
* Override defaultActions() to remove summary actions.
*/
protected function defaultActions($which = NULL) {
if ($which) {
if (in_array($which, array(
'ignore',
'not found',
'empty',
'default',
))) {
return parent::defaultActions($which);
}
return;
}
$actions = parent::defaultActions();
unset($actions['summary asc']);
unset($actions['summary desc']);
unset($actions['summary asc by count']);
unset($actions['summary desc by count']);
return $actions;
}
public function query($group_by = FALSE) {
$this
->ensureMyTable();
if (!empty($this->options['break_phrase'])) {
$tids = new \stdClass();
$tids->value = $this->argument;
$tids = $this
->breakPhrase($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
->addWhere(0, "{$this->tableAlias}.{$this->realField}", $subquery, 'IN');
}
function title() {
$term = taxonomy_term_load($this->argument);
if (!empty($term)) {
return check_plain($term
->label());
}
// TODO review text
return t('No name');
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
IndexTidDepth:: |
protected | function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides ArgumentPluginBase:: |
|
IndexTidDepth:: |
public | function |
Build the options form. Overrides ArgumentPluginBase:: |
|
IndexTidDepth:: |
public | 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 ArgumentPluginBase:: |
|
IndexTidDepth:: |
protected | function |
Override defaultActions() to remove summary actions. Overrides ArgumentPluginBase:: |
|
IndexTidDepth:: |
public | function |
Set up the query for this argument. Overrides ArgumentPluginBase:: |
|
IndexTidDepth:: |
function |
Get the title this argument will assign the view, given the argument. Overrides ArgumentPluginBase:: |
||
ArgumentPluginBase:: |
public | function |
Overrides Drupal\views\Plugin\views\HandlerBase:init(). Overrides HandlerBase:: |
4 |
ArgumentPluginBase:: |
public | function | Determine if the argument can generate a breadcrumb | |
ArgumentPluginBase:: |
public | function | ||
ArgumentPluginBase:: |
public | function | ||
ArgumentPluginBase:: |
public | function | Determine if the argument needs a style plugin. | |
ArgumentPluginBase:: |
public | function |
Validate the options form. Overrides HandlerBase:: |
|
ArgumentPluginBase:: |
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 HandlerBase:: |
|
ArgumentPluginBase:: |
public | function | Provide a form for selecting the default argument when the default action is set to provide default argument. | 1 |
ArgumentPluginBase:: |
public | function | Provide a form for selecting further summary options when the default action is set to display one. | |
ArgumentPluginBase:: |
function | Handle the default action, which means our argument wasn't present. | ||
ArgumentPluginBase:: |
public | function | How to act if validation failes | |
ArgumentPluginBase:: |
public | function | Default action: ignore. | |
ArgumentPluginBase:: |
protected | function | Default action: not found. | |
ArgumentPluginBase:: |
public | function | Default action: access denied. | |
ArgumentPluginBase:: |
public | function | Default action: empty | |
ArgumentPluginBase:: |
protected | function | This just returns true. The view argument builder will know where to find the argument from. | |
ArgumentPluginBase:: |
function | Determine if the argument is set to provide a default argument. | ||
ArgumentPluginBase:: |
public | function | Get a default argument, if available. | 1 |
ArgumentPluginBase:: |
public | function | Process the summary arguments for display. | |
ArgumentPluginBase:: |
protected | function | Default action: summary. | |
ArgumentPluginBase:: |
protected | function | Build the info for the summary query. | 3 |
ArgumentPluginBase:: |
protected | function | Add the name field, which is the field displayed in summary queries. This is often used when the argument is numeric. | |
ArgumentPluginBase:: |
public | function | Some basic summary behavior that doesn't need to be repeated as much as code that goes into summaryQuery() | |
ArgumentPluginBase:: |
public | function | Sorts the summary based upon the user's selection. The base variant of this is usually adequte. | |
ArgumentPluginBase:: |
public | 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->getUrl(). | 4 |
ArgumentPluginBase:: |
public | function | Provides the name to use for the summary. By default this is just the name field. | 8 |
ArgumentPluginBase:: |
public | 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(). | |
ArgumentPluginBase:: |
public | function | Validate that this argument works. By default, all arguments are valid. | |
ArgumentPluginBase:: |
public | function | Called by the menu system to validate an argument. | |
ArgumentPluginBase:: |
public | function | Set the input for this argument | |
ArgumentPluginBase:: |
public | function | Get the value of this argument. | |
ArgumentPluginBase:: |
public | function | Get the display or row plugin, if it exists. | |
ArgumentPluginBase:: |
public | function | Return a description of how the argument would normally be sorted. | 5 |
ArgumentPluginBase:: |
public static | function | Custom form radios process function. | |
HandlerBase:: |
public | function |
Constructs a Handler object. Overrides PluginBase:: |
3 |
HandlerBase:: |
public | function | Return a string representing this handler's name in the UI. | 9 |
HandlerBase:: |
public | function | Shortcut to get a handler's raw field value. | |
HandlerBase:: |
public | function | Sanitize the value for output. | |
HandlerBase:: |
protected | function | Transform a string by a certain method. | |
HandlerBase:: |
public | function | Provides the handler some groupby. | 2 |
HandlerBase:: |
public | function | Provide a form for aggregation settings. | 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. | 1 |
HandlerBase:: |
public | function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | 1 |
HandlerBase:: |
public | function | Provide defaults for the handler. | |
HandlerBase:: |
public | function | Provide a form for setting options. | 1 |
HandlerBase:: |
public | function | Validate the options form. | |
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 | Determine if a handler can be exposed. | 2 |
HandlerBase:: |
public | function | Set new exposed option defaults when exposed setting is flipped on. | 2 |
HandlerBase:: |
public | function | Get information about the exposed form for the form renderer. | 1 |
HandlerBase:: |
public | function | Render our chunk of the exposed handler form when selecting | 1 |
HandlerBase:: |
public | function | Validate the exposed handler form | 4 |
HandlerBase:: |
public | function | Submit the exposed handler form | |
HandlerBase:: |
public | function | Form for exposed handler options. | 2 |
HandlerBase:: |
public | function | Validate the options form. | 1 |
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 | Shortcut to display the expose/hide button. | 2 |
HandlerBase:: |
public | function | Shortcut to display the exposed options form. | |
HandlerBase:: |
public | function | Check whether current user has access to this handler. | 6 |
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 | Called just prior to query(), this lets a handler set up any relationship it needs. | |
HandlerBase:: |
public | function | Ensure the main table for this handler is in the query. This is used a lot. | 8 |
HandlerBase:: |
public | function | Provide text for the administrative summary | 4 |
HandlerBase:: |
public | function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
HandlerBase:: |
public | function | Returns TRUE if the exposed filter works like a grouped filter. | 1 |
HandlerBase:: |
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 |
HandlerBase:: |
public | function | Take input from exposed handlers and assign to this handler, if necessary. | 1 |
HandlerBase:: |
public | function | If set to remember exposed input in the session, store it there. | 1 |
HandlerBase:: |
public | function | Get the join object that should be used for this handler. | |
HandlerBase:: |
public | function |
Validates the handler against the complete View. Overrides PluginBase:: |
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 | function | Creates cross-database SQL date formatting. | |
HandlerBase:: |
public | function | Creates cross-database SQL dates. | |
HandlerBase:: |
public static | function | Fetches a handler to join one table to a primary table from the data cache. | |
HandlerBase:: |
public | function | Determines the entity type used by this handler. | |
HandlerBase:: |
public static | function | Breaks x,y,z and x+y+z into an array. Numeric only. | |
HandlerBase:: |
public static | function | Breaks x,y,z and x+y+z into an array. Works for strings. | |
HandlerBase:: |
public | function | Displays the Expose form. | |
HandlerBase:: |
public | function | A submit handler that is used for storing temporary items when using multi-step changes, such as ajax requests. | |
PluginBase:: |
protected | function | Fills up the options of the plugin with defaults. | |
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 | Clears a plugin. | 2 |
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:: |
public | function | Return the human readable name of the display. | |
PluginBase:: |
public | function | Returns the usesOptions property. | 8 |
PluginBase:: |
public | function | Returns a string with any core tokens replaced. | |
PluginBase:: |
public | function | Returns an array of available token replacements. | |
PluginBase:: |
public | function | Adds elements for available core tokens to a form. | |
ContainerFactoryPluginBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
11 |
PluginBase:: |
public | function |
Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function |
Returns the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
|
ArgumentPluginBase:: |
property | |||
ArgumentPluginBase:: |
property | |||
ArgumentPluginBase:: |
property | 1 | ||
ArgumentPluginBase:: |
property | The table to use for the name, should it not be in the same table as the argument. | ||
ArgumentPluginBase:: |
property | The field to use for the name to use in the summary, which is the displayed output. For example, for the node: nid argument, the argument itself is the nid, but node.title is displayed. | ||
HandlerBase:: |
public | property | Where the $query object will reside: | 1 |
HandlerBase:: |
public | property | The table this handler is attached to. | |
HandlerBase:: |
public | property | The alias of the table of this handler which is used in the query. | |
HandlerBase:: |
public | property | When a table has been moved this property is set. | |
HandlerBase:: |
public | property | The actual field in the database table, maybe different on other kind of query plugins/special handlers. | |
HandlerBase:: |
public | property | With field you can override the realField if the real field is not set. | |
HandlerBase:: |
public | property | When a field has been moved this property is set. | |
HandlerBase:: |
public | property | The relationship used for this field. | |
PluginBase:: |
public | property | Options for this plugin will be held here. | |
PluginBase:: |
public | property | The top object of a view. | 1 |
PluginBase:: |
public | property | The display object this plugin is for. | |
PluginBase:: |
public | property | Plugins's definition | |
PluginBase:: |
protected | property | Denotes whether the plugin has an additional options form. | 8 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
protected | property | The plugin implementation definition. | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |