class views_handler_field_taxonomy
- 3.x modules/taxonomy/views_handler_field_taxonomy.inc views_handler_field_taxonomy
- 2.x modules/taxonomy/views_handler_field_taxonomy.inc views_handler_field_taxonomy
Field handler to provide simple renderer that allows linking to a taxonomy term.
Hierarchy
- class \views_object
- class \views_handler
- class \views_handler_field
- class \views_handler_field_taxonomy
- class \views_handler_field
- class \views_handler
Expanded class hierarchy of views_handler_field_taxonomy
2 string references to 'views_handler_field_taxonomy'
- taxonomy_views_data in modules/
taxonomy.views.inc - Implementation of hook_views_data()
- taxonomy_views_handlers in modules/
taxonomy.views.inc - Implementation of hook_views_handlers() to register all of the basic handlers views uses.
File
- modules/
taxonomy/ views_handler_field_taxonomy.inc, line 7
View source
class views_handler_field_taxonomy extends views_handler_field {
/**
* Constructor to provide additional field to add.
*
* This constructer assumes the term_data table. If using another
* table, we'll need to be more specific.
*/
function construct() {
parent::construct();
$this->additional_fields['vid'] = 'vid';
$this->additional_fields['tid'] = 'tid';
}
function option_definition() {
$options = parent::option_definition();
$options['link_to_taxonomy'] = array('default' => FALSE);
return $options;
}
/**
* Provide link to taxonomy option
*/
function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
$form['link_to_taxonomy'] = array(
'#title' => t('Link this field to its taxonomy term page'),
'#description' => t('This will override any other link you have set.'),
'#type' => 'checkbox',
'#default_value' => !empty($this->options['link_to_taxonomy']),
);
}
/**
* Render whatever the data is as a link to the taxonomy.
*
* Data should be made XSS safe prior to calling this function.
*/
function render_link($data, $values) {
if (!empty($this->options['link_to_taxonomy']) && !empty($values->{$this->aliases['tid']}) && $data !== NULL && $data !== '') {
$term = new stdClass();
$term->tid = $values->{$this->aliases['tid']};
$term->vid = $values->{$this->aliases['vid']};
$this->options['alter']['make_link'] = TRUE;
$this->options['alter']['path'] = taxonomy_term_path($term);
}
return $data;
}
function render($values) {
return $this->render_link(check_plain($values->{$this->field_alias}), $values);
}
}
Members
Name | Modifiers | Type | Description |
---|---|---|---|
views_handler:: |
function | Take input from exposed filters and assign to this handler, if necessary. | |
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 | Determine if a handler can be exposed. | |
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 filter form when selecting | |
views_handler:: |
function | Get information about the exposed form for the form renderer. | |
views_handler:: |
function | Submit the exposed filter form | |
views_handler:: |
function | Validate the exposed filter form | |
views_handler:: |
function | Set new exposed option defaults when exposed setting is flipped on. | |
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 | 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. | |
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 | 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 | Run before the view is built. | |
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. | |
views_handler:: |
function | Return a string representing this handler's name in the UI. | |
views_handler:: |
function | Validates the handler against the complete View. | |
views_handler_field:: |
function | Add 'additional' fields to the query. | |
views_handler_field:: |
function | Add any special tokens this field might use for itself. | |
views_handler_field:: |
function |
Provide extra data to the administration form Overrides views_handler:: |
|
views_handler_field:: |
function | Render a field using advanced settings. | |
views_handler_field:: |
function | Determine if this field can allow advanced rendering. | |
views_handler_field:: |
function | Called to determine what to tell the clicksorter. | |
views_handler_field:: |
function | Determine if this field is click sortable. | |
views_handler_field:: |
function | Document any special tokens this field might use for itself. | |
views_handler_field:: |
function | Return DIV or SPAN based upon the field's element type. | |
views_handler_field:: |
function | Get the 'render' tokens to use for advanced rendering. | |
views_handler_field:: |
function |
init the handler with necessary data. Overrides views_handler:: |
|
views_handler_field:: |
function | Get this field's label. | |
views_handler_field:: |
function | Run before any fields are rendered. | |
views_handler_field:: |
function |
Called to add the field to a query. Overrides views_handler:: |
|
views_handler_field:: |
function | Render this field as altered text, from a fieldset set by the user. | |
views_handler_field:: |
function | Render this field as a link, with the info from a fieldset set by the user. | |
views_handler_field:: |
function | Perform an advanced text render for the item. | |
views_handler_field:: |
function | Trim the field down to the specified length. | |
views_handler_field:: |
function | Call out to the theme() function, which probably just calls render() but allows sites to override output fairly easily. | |
views_handler_field:: |
function | ||
views_handler_field_taxonomy:: |
function |
Constructor to provide additional field to add. Overrides views_handler_field:: |
|
views_handler_field_taxonomy:: |
function |
Provide link to taxonomy option Overrides views_handler_field:: |
|
views_handler_field_taxonomy:: |
function |
Information about options for all kinds of purposes will be held here. Overrides views_handler_field:: |
|
views_handler_field_taxonomy:: |
function |
Render the field. Overrides views_handler_field:: |
|
views_handler_field_taxonomy:: |
function | Render whatever the data is as a link to the taxonomy. | |
views_object:: |
function | ||
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 |