class views_handler_filter_many_to_one
- 3.x handlers/views_handler_filter_many_to_one.inc views_handler_filter_many_to_one
- 2.x handlers/views_handler_filter_many_to_one.inc views_handler_filter_many_to_one
Complex filter to handle filtering for many to one relationships, such as terms (many terms per node) or roles (many roles per user).
The construct method needs to be overridden to provide a list of options; alternately, the value_form and admin_summary methods need to be overriden to provide something that isn't just a select list.
Hierarchy
- class \views_object
- class \views_handler
- class \views_handler_filter
- class \views_handler
Expanded class hierarchy of views_handler_filter_many_to_one
3 string references to 'views_handler_filter_many_to_one'
- taxonomy_views_handlers in modules/
taxonomy.views.inc - Implementation of hook_views_handlers() to register all of the basic handlers views uses.
- user_views_handlers in modules/
user.views.inc - Implementation of hook_views_handlers() to register all of the basic handlers views uses.
- views_views_handlers in includes/
handlers.inc - Implementation of hook_views_handlers() to register all of the basic handlers views uses.
File
- handlers/
views_handler_filter_many_to_one.inc, line 11
View source
class views_handler_filter_many_to_one extends views_handler_filter_in_operator {
function init(&$view, $options) {
parent::init($view, $options);
$this->helper = new views_many_to_one_helper($this);
}
function option_definition() {
$options = parent::option_definition();
$options['operator']['default'] = 'or';
$options['value']['default'] = array();
return $options;
}
function operators() {
$operators = array(
'or' => array(
'title' => t('Is one of'),
'short' => t('or'),
'short_single' => t('='),
'method' => 'op_helper',
'values' => 1,
'ensure_my_table' => 'helper',
),
'and' => array(
'title' => t('Is all of'),
'short' => t('and'),
'short_single' => t('='),
'method' => 'op_helper',
'values' => 1,
'ensure_my_table' => 'helper',
),
'not' => array(
'title' => t('Is none of'),
'short' => t('not'),
'short_single' => t('<>'),
'method' => 'op_helper',
'values' => 1,
'ensure_my_table' => 'helper',
),
);
// if the definition allows for the empty operator, add it.
if (!empty($this->definition['allow empty'])) {
$operators += array(
'empty' => array(
'title' => t('Is empty (NULL)'),
'method' => 'op_empty',
'short' => t('empty'),
'values' => 0,
),
'not empty' => array(
'title' => t('Is not empty (NOT NULL)'),
'method' => 'op_empty',
'short' => t('not empty'),
'values' => 0,
),
);
}
return $operators;
}
var $value_form_type = 'select';
function value_form(&$form, &$form_state) {
parent::value_form($form, $form_state);
if (empty($form_state['exposed'])) {
$this->helper->options_form($form, $form_state);
}
}
/**
* Override ensure_my_table so we can control how this joins in.
* The operator actually has influence over joining.
*/
function ensure_my_table() {
// Defer to helper if the operator specifies it.
$info = $this->operators();
if (isset($info[$this->operator]['ensure_my_table']) && $info[$this->operator]['ensure_my_table'] == 'helper') {
return $this->helper->ensure_my_table();
}
return parent::ensure_my_table();
}
function op_helper() {
if (empty($this->value)) {
return;
}
$this->helper->add_filter();
}
}
Members
Name | Modifiers | Type | Description |
---|---|---|---|
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 | Submit the exposed filter form | |
views_handler:: |
function | Validate the exposed filter form | |
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 | 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 | Return a string representing this handler's name in the UI. | |
views_handler:: |
function | Validates the handler against the complete View. | |
views_handler_filter:: |
function |
Determine if a filter can be exposed. Overrides views_handler:: |
|
views_handler_filter:: |
function |
Render our chunk of the exposed filter form when selecting Overrides views_handler:: |
|
views_handler_filter:: |
function |
Tell the renderer about our exposed form. This only needs to be
overridden for particularly complex forms. And maybe not even then. Overrides views_handler:: |
|
views_handler_filter:: |
function | Make some translations to a form item to make it more suitable to exposing. | |
views_handler_filter:: |
function | Overridable form for exposed filter options. | |
views_handler_filter:: |
function | Handle the 'left' side fo the exposed options form. | |
views_handler_filter:: |
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_filter:: |
function | Validate the options form. | |
views_handler_filter:: |
function | Provide a form for setting the operator. | |
views_handler_filter:: |
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_filter:: |
function | Validate the operator form. | |
views_handler_filter:: |
function |
Provide the basic form which calls through to subforms.
If overridden, it is best to call through to the parent,
or to at least make sure all of the functions in this form
are called. Overrides views_handler:: |
|
views_handler_filter:: |
function |
Simple submit handler Overrides views_handler:: |
|
views_handler_filter:: |
function |
Simple validate handler Overrides views_handler:: |
|
views_handler_filter:: |
function | Shortcut to display the expose/hide button. | |
views_handler_filter:: |
function | Shortcut to display the exposed options form. | |
views_handler_filter:: |
function | Shortcut to display the operator form. | |
views_handler_filter:: |
function | Shortcut to display the value form. | |
views_handler_filter:: |
function |
If set to remember exposed input in the session, store it there. Overrides views_handler:: |
|
views_handler_filter:: |
function | Validate the options form. | |
views_handler_filter_in_operator:: |
function |
Check to see if input from the exposed filters should change
the behavior of this filter. Overrides views_handler_filter:: |
|
views_handler_filter_in_operator:: |
function |
Display the filter on the administrative summary Overrides views_handler_filter:: |
|
views_handler_filter_in_operator:: |
function |
Views handlers use a special construct function so that we can more
easily construct them with variable arguments. Overrides views_object:: |
|
views_handler_filter_in_operator:: |
function |
Handle the 'right' side fo the exposed options form. Overrides views_handler_filter:: |
|
views_handler_filter_in_operator:: |
function |
Provide default options for exposed filters. Overrides views_handler_filter:: |
|
views_handler_filter_in_operator:: |
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. | |
views_handler_filter_in_operator:: |
function |
Build strings from the operators() for 'select' options Overrides views_handler_filter:: |
|
views_handler_filter_in_operator:: |
function | ||
views_handler_filter_in_operator:: |
function | ||
views_handler_filter_in_operator:: |
function | ||
views_handler_filter_in_operator:: |
function |
Add this filter to the query. Overrides views_handler_filter:: |
|
views_handler_filter_in_operator:: |
function | When using exposed filters, we may be required to reduce the set. | |
views_handler_filter_in_operator:: |
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_filter:: |
|
views_handler_filter_many_to_one:: |
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:: |
function |
Provide some extra help to get the operator/value easier to use. Overrides views_handler_filter:: |
|
views_handler_filter_many_to_one:: |
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:: |
|
views_handler_filter_many_to_one:: |
function |
Information about options for all kinds of purposes will be held here. Overrides views_handler_filter_in_operator:: |
|
views_handler_filter_many_to_one:: |
function | ||
views_handler_filter_many_to_one:: |
function |
Provide a form for setting options. Overrides views_handler_filter_in_operator:: |
|
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 |