class views_handler_relationship_node_term_data in Views (for Drupal 7) 6.2
Same name and namespace in other branches
- 6.3 modules/taxonomy/views_handler_relationship_node_term_data.inc \views_handler_relationship_node_term_data
- 7.3 modules/taxonomy/views_handler_relationship_node_term_data.inc \views_handler_relationship_node_term_data
@file Views' relationship handlers.
Hierarchy
- class \views_object
- class \views_handler
Expanded class hierarchy of views_handler_relationship_node_term_data
1 string reference to 'views_handler_relationship_node_term_data'
- taxonomy_views_data_alter in modules/
taxonomy.views.inc - Implementation of hook_views_data_alter().
File
- modules/
taxonomy/ views_handler_relationship_node_term_data.inc, line 7 - Views' relationship handlers.
View source
class views_handler_relationship_node_term_data extends views_handler_relationship {
function option_definition() {
$options = parent::option_definition();
$options['vids'] = array(
'default' => array(),
);
return $options;
}
/**
* Default options form that provides the label widget that all fields
* should have.
*/
function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
$vocabularies = taxonomy_get_vocabularies();
$options = array();
foreach ($vocabularies as $voc) {
$options[$voc->vid] = check_plain($voc->name);
}
$form['vids'] = array(
'#type' => 'checkboxes',
'#title' => t('Vocabularies'),
'#options' => $options,
'#default_value' => $this->options['vids'],
'#description' => t('Choose which vocabularies you wish to relate. Remember that every term found will create a new record, so this relationship is best used on just one vocabulary that has only one term per node.'),
);
}
/**
* Called to implement a relationship in a query.
*/
function query() {
$this
->ensure_my_table();
$def = $this->definition;
$def['table'] = 'term_data';
if (!empty($this->options['required']) || !array_filter($this->options['vids'])) {
$term_node = $this->query
->add_table('term_node', $this->relationship);
$def['left_table'] = $term_node;
$def['left_field'] = 'tid';
$def['field'] = 'tid';
if (!empty($this->options['required'])) {
$def['type'] = 'INNER';
}
}
else {
// If the join is optional, join a subselect that will emulate term_data table instead
$def['left_table'] = $this->table_alias;
$def['left_field'] = 'vid';
$def['field'] = 'revision';
// fapi ensures vids are safe here.
$vids = implode(', ', array_filter($this->options['vids']));
$def['table formula'] = "(SELECT t.*, tn.vid AS revision FROM {term_data} t INNER JOIN {term_node} tn ON tn.tid = t.tid WHERE t.vid IN ({$vids}))";
}
$join = new views_join();
$join->definition = $def;
$join
->construct();
$join->adjusted = TRUE;
// use a short alias for this:
$alias = $def['table'] . '_' . $this->table;
$this->alias = $this->query
->add_relationship($alias, $join, 'term_data', $this->relationship);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
views_handler:: |
function | Take input from exposed filters and assign to this handler, if necessary. | 1 | |
views_handler:: |
function | Check whether current user has access to this handler. | 5 | |
views_handler:: |
function | Provide text for the administrative summary | 3 | |
views_handler:: |
function | Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. | 5 | |
views_handler:: |
function | Determine if a handler can be exposed. | 1 | |
views_handler:: |
function | Ensure the main table for this handler is in the query. This is used a lot. | 7 | |
views_handler:: |
function | Render our chunk of the exposed filter form when selecting | 1 | |
views_handler:: |
function | Get information about the exposed form for the form renderer. | 1 | |
views_handler:: |
function | Submit the exposed filter form | ||
views_handler:: |
function | Validate the exposed filter form | 4 | |
views_handler:: |
function | Set new exposed option defaults when exposed setting is flipped on. | 1 | |
views_handler:: |
function | Provide defaults for the handler. | ||
views_handler:: |
function | Provide a form for setting options. | 1 | |
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 | Get the join object that should be used for this handler. | ||
views_handler:: |
function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | 1 | |
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. | 1 | |
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. | 1 | |
views_handler:: |
function | Validate the options form. | 1 | |
views_handler:: |
function | Run before the view is built. | 1 | |
views_handler:: |
function | Called just prior to query(), this lets a handler set up any relationship it needs. | ||
views_handler:: |
function | If set to remember exposed input in the session, store it there. | 1 | |
views_handler:: |
function | Return a string representing this handler's name in the UI. | 5 | |
views_handler:: |
function | Validates the handler against the complete View. | ||
views_handler_relationship:: |
function |
Init handler to let relationships live on tables other than
the table they operate on. Overrides views_handler:: |
||
views_handler_relationship:: |
function | Get this field's label. | ||
views_handler_relationship_node_term_data:: |
function |
Default options form that provides the label widget that all fields
should have. Overrides views_handler_relationship:: |
||
views_handler_relationship_node_term_data:: |
function |
Information about options for all kinds of purposes will be held here. Overrides views_handler_relationship:: |
||
views_handler_relationship_node_term_data:: |
function |
Called to implement a relationship in a query. Overrides views_handler_relationship:: |
||
views_object:: |
property | Except for displays, options for the object will be held here. | 1 | |
views_object:: |
function | Views handlers use a special construct function so that we can more easily construct them with variable arguments. | 5 | |
views_object:: |
function | 2 | ||
views_object:: |
function | Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility. | 1 | |
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 | 1 |