class cshs_handler_filter_term_node_tid in Client-side Hierarchical Select 7
Filter by term id (including selection by client-side hierarchical select).
Hierarchy
- class \views_object
- class \views_handler
Expanded class hierarchy of cshs_handler_filter_term_node_tid
1 string reference to 'cshs_handler_filter_term_node_tid'
- cshs_field_views_data_alter in ./
cshs.module - Implements hook_field_views_data_alter().
File
- includes/
handlers/ cshs_handler_filter_term_node_tid.inc, line 13 - Definition of cshs_handler_filter_term_node_tid.
View source
class cshs_handler_filter_term_node_tid extends views_handler_filter_term_node_tid {
/**
* Define settings for this filter handler.
*/
function option_definition() {
$options = parent::option_definition();
$options['type'] = array(
'default' => 'cshs',
);
$options['level_labels'] = array(
'default' => '',
);
return $options;
}
function extra_options_form(&$form, &$form_state) {
parent::extra_options_form($form, $form_state);
$form['type']['#options'] += array(
'cshs' => t('Client-side hierarchical select'),
);
}
/**
* Define the form which is displayed, when this filter is set to "exposed".
*/
function expose_form(&$form, &$form_state) {
parent::expose_form($form, $form_state);
// Disable the "multiple" option in the exposed form settings.
$form['expose']['multiple']['#access'] = FALSE;
// Add a textfield for labels per level.
$form['level_labels'] = array(
'#type' => 'textfield',
'#title' => t('Labels per hierarchy-level'),
'#description' => t('Enter labels for each hierarchy-level separated by comma.'),
'#default_value' => isset($this->options['level_labels']) ? $this->options['level_labels'] : '',
);
}
/**
* Define the actual exposed form.
*/
function value_form(&$form, &$form_state) {
global $language;
parent::value_form($form, $form_state);
$vocabulary = taxonomy_vocabulary_machine_name_load($this->options['vocabulary']);
if (empty($vocabulary) && $this->options['limit']) {
$form['markup'] = array(
'#markup' => '<div class="form-item">' . t('An invalid vocabulary is selected. Please change it in the options.') . '</div>',
);
return;
}
if ($this->options['type'] == 'cshs' && $this->options['exposed']) {
// Set the element type to CSHS.
$form['value']['#type'] = 'cshs';
// Get the options in a special form.
$options = _cshs_get_options($this->options['vocabulary']);
$form['value']['#options'] = $options;
// Add a "none" option.
//$form['value']['#options'][CSHS_DEFAULT_NONE_VALUE] = CSHS_DEFAULT_NONE_LABEL;
_cshs_add_none_option($form['value']['#options']);
$form['value']['#default_value'] = CSHS_DEFAULT_NONE_VALUE;
// Set the level labels if defined.
$labels = array();
if (isset($this->options['level_labels']) && strlen($this->options['level_labels'])) {
$labels = drupal_explode_tags($this->options['level_labels']);
}
$form['value']['#labels'] = $labels;
}
if (empty($form_state['exposed'])) {
// Retain the helper option.
$this->helper
->options_form($form, $form_state);
}
}
function admin_summary() {
// Set up $this->value_options for the parent summary.
$this->value_options = array();
if ($this->value == 'All') {
$this->value = NULL;
}
return parent::admin_summary();
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
cshs_handler_filter_term_node_tid:: |
function |
Display the filter on the administrative summary. Overrides views_handler_filter_term_node_tid:: |
||
cshs_handler_filter_term_node_tid:: |
function |
Define the form which is displayed, when this filter is set to "exposed". Overrides views_handler_filter_term_node_tid:: |
||
cshs_handler_filter_term_node_tid:: |
function |
Provide a form for setting options. Overrides views_handler_filter_term_node_tid:: |
||
cshs_handler_filter_term_node_tid:: |
function |
Define settings for this filter handler. Overrides views_handler_filter_term_node_tid:: |
||
cshs_handler_filter_term_node_tid:: |
function |
Define the actual exposed form. Overrides views_handler_filter_term_node_tid:: |
||
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 | Check whether current user has access to this handler. | 10 |
views_handler:: |
public | function | Determine if the handler is considered 'broken'. | 6 |
views_handler:: |
public | function | Transform a string by a certain method. | |
views_handler:: |
public | function | Submit the exposed handler form. | |
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 | Provide defaults for the handler. | |
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 | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
views_handler:: |
public | function | Determine if the argument needs a style plugin. | 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 exposed options form. | |
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_filter:: |
public | property | Disable the possibility to force a single value. | 6 |
views_handler_filter:: |
public | property | Disable the possibility to allow a exposed input to be optional. | |
views_handler_filter:: |
public | property | Contains the information of the selected item in a gruped filter. | |
views_handler_filter:: |
public | property | Disable the possibility to use operators. | 2 |
views_handler_filter:: |
public | property | Contains the operator which is used on the query. | |
views_handler_filter:: |
public | property | Contains the actual value of the field. | |
views_handler_filter:: |
public | function | Build the form to let users create the group of exposed filters. | |
views_handler_filter:: |
public | function | Provide default options for exposed filters. | |
views_handler_filter:: |
public | function | Save new group items, re-enumerates and remove groups marked to delete. | |
views_handler_filter:: |
public | function | Validate the build group options form. | 1 |
views_handler_filter:: |
public | function | Determine if a filter can be converted into a group. | |
views_handler_filter:: |
public | function |
Determine if a filter can be exposed. Overrides views_handler:: |
5 |
views_handler_filter:: |
public | function | Can this filter be used in OR groups? | 1 |
views_handler_filter:: |
public | function | Transform the input from a grouped filter into a standard filter. | |
views_handler_filter:: |
public | function |
Render our chunk of the exposed filter form when selecting. Overrides views_handler:: |
|
views_handler_filter:: |
public | function |
Tell the renderer about our exposed form. Overrides views_handler:: |
|
views_handler_filter:: |
public | function | Make some translations to a form item to make it more suitable to exposing. | |
views_handler_filter:: |
public | function |
Validate the options form. Overrides views_handler:: |
|
views_handler_filter:: |
public | function | Build a form with a group of operator | values to apply as a single filter. | |
views_handler_filter:: |
public | function | Options available for a grouped filter which uses checkboxes. | |
views_handler_filter:: |
public | function |
Returns TRUE if the exposed filter works like a grouped filter. Overrides views_handler:: |
|
views_handler_filter:: |
public | function |
Indicate whether users can select multiple group items. Overrides views_handler:: |
|
views_handler_filter:: |
public | function | Options form subform for setting the operator. | 6 |
views_handler_filter:: |
public | function | Perform any necessary changes to the form values prior to storage. | |
views_handler_filter:: |
public | function | Validate the operator form. | |
views_handler_filter:: |
public | function |
Provide the basic form which calls through to subforms. Overrides views_handler:: |
4 |
views_handler_filter:: |
public | function |
Simple submit handler. Overrides views_handler:: |
|
views_handler_filter:: |
public | function |
Simple validate handler. Overrides views_handler:: |
1 |
views_handler_filter:: |
public | function | Sanitizes the HTML select element's options. | |
views_handler_filter:: |
public | function | Shortcut to display the build_group/hide button. | |
views_handler_filter:: |
public | function | Shortcut to display the exposed options form. | |
views_handler_filter:: |
public | function |
Shortcut to display the expose/hide button. Overrides views_handler:: |
|
views_handler_filter:: |
public | function | Shortcut to display the operator form. | |
views_handler_filter:: |
public | function | Shortcut to display the value form. | |
views_handler_filter:: |
public | function |
Store the exposed input for processing later. Overrides views_handler:: |
|
views_handler_filter:: |
public | function | If set to remember exposed input in the session, store it there. | |
views_handler_filter_in_operator:: |
public | property | Stores all operations which are available on the form. | |
views_handler_filter_in_operator:: |
public | function |
Views handlers use a special construct function. Overrides views_object:: |
|
views_handler_filter_in_operator:: |
public | function |
Provide default options for exposed filters. Overrides views_handler_filter:: |
|
views_handler_filter_in_operator:: |
public | function |
Build strings from the operators() for 'select' options. Overrides views_handler_filter:: |
2 |
views_handler_filter_in_operator:: |
public | function | ||
views_handler_filter_in_operator:: |
public | function | ||
views_handler_filter_in_operator:: |
public | function | ||
views_handler_filter_in_operator:: |
public | function |
Add this filter to the query. Overrides views_handler_filter:: |
5 |
views_handler_filter_in_operator:: |
public | function | When using exposed filters, we may be required to reduce the set. | |
views_handler_filter_in_operator:: |
public | function |
Validates the handler against the complete View. Overrides views_handler:: |
|
views_handler_filter_many_to_one:: |
public | property | Stores the Helper object which handles the many_to_one complexity. | |
views_handler_filter_many_to_one:: |
public | property |
Overrides views_handler_filter_in_operator:: |
|
views_handler_filter_many_to_one:: |
public | function |
Override ensure_my_table so we can control how this joins in.
The operator actually has influence over joining. Overrides views_handler:: |
|
views_handler_filter_many_to_one:: |
public | function |
This kind of construct makes it relatively easy for a child class to add or
remove functionality by overriding this function and adding/removing items
from this array. Overrides views_handler_filter_in_operator:: |
1 |
views_handler_filter_many_to_one:: |
public | function | ||
views_handler_filter_term_node_tid:: |
public | property | Stores the exposed input for this filter. | |
views_handler_filter_term_node_tid:: |
public | function |
Check to see if input from the exposed filters should change the behavior. Overrides views_handler_filter_in_operator:: |
|
views_handler_filter_term_node_tid:: |
public | function |
Validate the exposed handler form. Overrides views_handler:: |
|
views_handler_filter_term_node_tid:: |
public | function |
Child classes should be used to override this function and set the
'value options', unless 'options callback' is defined as a valid function
or static public method to generate these values. Overrides views_handler_filter_in_operator:: |
|
views_handler_filter_term_node_tid:: |
public | function |
If a handler has 'extra options' it will get a little settings widget and
another form called extra_options. Overrides views_handler:: |
|
views_handler_filter_term_node_tid:: |
public | function |
Provide some extra help to get the operator/value easier to use. Overrides views_handler_filter_many_to_one:: |
|
views_handler_filter_term_node_tid:: |
public | function | Validate the user string. Since this can come from either the form or the exposed filter, this is abstracted out a bit so it can handle the multiple input sources. | |
views_handler_filter_term_node_tid:: |
public | function |
Perform any necessary changes to the form values prior to storage. Overrides views_handler_filter_in_operator:: |
|
views_handler_filter_term_node_tid:: |
public | function |
Validate the options form. Overrides views_handler_filter:: |
|
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 |