class views_handler_argument_many_to_one
- 3.x handlers/views_handler_argument_many_to_one.inc views_handler_argument_many_to_one
- 2.x handlers/views_handler_argument_many_to_one.inc views_handler_argument_many_to_one
An argument handler for use in fields that have a many to one relationship with the table(s) to the left. This adds a bunch of options that are reasonably common with this type of relationship. Definition terms:
- numeric: If true, the field will be considered numeric. Probably should always be set TRUE as views_handler_argument_string has many to one capabilities.
- zero is null: If true, a 0 will be handled as empty, so for example a default argument can be provided or a summary can be shown.
Hierarchy
- class \views_object
- class \views_handler
- class \views_handler_argument
- class \views_handler
Expanded class hierarchy of views_handler_argument_many_to_one
Related topics
File
- handlers/
views_handler_argument_many_to_one.inc, line 21 - Definition of views_handler_argument_many_to_one.
View source
class views_handler_argument_many_to_one extends views_handler_argument {
function init(&$view, &$options) {
parent::init($view, $options);
$this->helper = new views_many_to_one_helper($this);
// Ensure defaults for these, during summaries and stuff:
$this->operator = 'or';
$this->value = array();
}
function option_definition() {
$options = parent::option_definition();
if (!empty($this->definition['numeric'])) {
$options['break_phrase'] = array('default' => FALSE, 'bool' => TRUE);
}
$options['add_table'] = array('default' => FALSE, 'bool' => TRUE);
$options['require_value'] = array('default' => FALSE, 'bool' => TRUE);
if (isset($this->helper)) {
$this->helper->option_definition($options);
}
else {
$helper = new views_many_to_one_helper($this);
$helper->option_definition($options);
}
return $options;
}
function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
// allow + for or, , for and
if (!empty($this->definition['numeric'])) {
$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 (for OR) or 1,2,3 (for AND).'),
'#default_value' => !empty($this->options['break_phrase']),
'#fieldset' => 'more',
);
}
$form['add_table'] = array(
'#type' => 'checkbox',
'#title' => t('Allow multiple filter values to work together'),
'#description' => t('If selected, multiple instances of this filter can work together, as though multiple values were supplied to the same filter. This setting is not compatible with the "Reduce duplicates" setting.'),
'#default_value' => !empty($this->options['add_table']),
'#fieldset' => 'more',
);
$form['require_value'] = array(
'#type' => 'checkbox',
'#title' => t('Do not display items with no value in summary'),
'#default_value' => !empty($this->options['require_value']),
'#fieldset' => 'more',
);
$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() {
$this->helper->ensure_my_table();
}
function query($group_by = FALSE) {
$empty = FALSE;
if (isset($this->definition['zero is null']) && $this->definition['zero is null']) {
if (empty($this->argument)) {
$empty = TRUE;
}
}
else {
if (!isset($this->argument)) {
$empty = TRUE;
}
}
if ($empty) {
parent::ensure_my_table();
$this->query->add_where(0, "$this->table_alias.$this->real_field", NULL, 'IS NULL');
return;
}
if (!empty($this->options['break_phrase'])) {
views_break_phrase($this->argument, $this);
}
else {
$this->value = array($this->argument);
$this->operator = 'or';
}
$this->helper->add_filter();
}
function title() {
if (!$this->argument) {
return !empty($this->definition['empty field name']) ? $this->definition['empty field name'] : t('Uncategorized');
}
if (!empty($this->options['break_phrase'])) {
views_break_phrase($this->argument, $this);
}
else {
$this->value = array($this->argument);
$this->operator = 'or';
}
// @todo -- both of these should check definition for alternate keywords.
if (empty($this->value)) {
return !empty($this->definition['empty field name']) ? $this->definition['empty field name'] : t('Uncategorized');
}
if ($this->value === array(-1)) {
return !empty($this->definition['invalid input']) ? $this->definition['invalid input'] : t('Invalid input');
}
return implode($this->operator == 'or' ? ' + ' : ', ', $this->title_query());
}
function summary_query() {
$field = $this->table . '.' . $this->field;
$join = $this->get_join();
if (!empty($this->options['require_value'])) {
$join->type = 'INNER';
}
if (empty($this->options['add_table']) || empty($this->view->many_to_one_tables[$field])) {
$this->table_alias = $this->query->ensure_table($this->table, $this->relationship, $join);
}
else {
$this->table_alias = $this->helper->summary_join();
}
// Add the field.
$this->base_alias = $this->query->add_field($this->table_alias, $this->real_field);
$this->summary_name_field();
return $this->summary_basics();
}
function summary_argument($data) {
$value = $data->{$this->base_alias};
if (empty($value)) {
$value = 0;
}
return $value;
}
/**
* Override for specific title lookups.
*/
function title_query() {
return $this->value;
}
}
Members
Name | Modifiers | Type | Description |
---|---|---|---|
views_handler:: |
public | property | The alias of the table of this handler which is used in the query. |
views_handler:: |
function | Take input from exposed handlers and assign to this handler, if necessary. | |
views_handler:: |
function | Check whether current user has access to this handler. | |
views_handler:: |
function | Provide text for the administrative summary | |
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 | Transform a string by a certain method. | |
views_handler:: |
function | Render our chunk of the exposed handler form when selecting | |
views_handler:: |
function | Get information about the exposed form for the form renderer. | |
views_handler:: |
function | Submit the exposed handler form | |
views_handler:: |
function | Validate the exposed handler form | |
views_handler:: |
function | Form for exposed handler options. | |
views_handler:: |
function | Set new exposed option defaults when exposed setting is flipped on. | |
views_handler:: |
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:: |
function | Validate the options 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 | Shortcut to get a handler's raw field value. | |
views_handler:: |
function | Get the join object that should be used for this handler. | |
views_handler:: |
function | Provide a form for aggregation settings. | |
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 | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | |
views_handler:: |
function | Returns TRUE if the exposed filter works like a grouped filter. | |
views_handler:: |
function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
views_handler:: |
function | Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. | |
views_handler:: |
function | Provides a unique placeholders for handlers. | |
views_handler:: |
function | Run after the view is executed, before the result is cached. | |
views_handler:: |
function | Run before the view is built. | |
views_handler:: |
function | Sanitize the value for output. | |
views_handler:: |
function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
views_handler:: |
function | Shortcut to display the expose/hide button. | |
views_handler:: |
function | Shortcut to display the exposed options form. | |
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 | Provides the handler some groupby. | |
views_handler:: |
function | Validates the handler against the complete View. | |
views_handler_argument:: |
function |
Constructor Overrides views_object:: |
|
views_handler_argument:: |
function | Default action: access denied. | |
views_handler_argument:: |
function | Handle the default action, which means our argument wasn't present. | |
views_handler_argument:: |
function | Provide a list of default behaviors for this argument if the argument is not present. | |
views_handler_argument:: |
function | Provide a form for selecting the default argument when the default action is set to provide default argument. | |
views_handler_argument:: |
function | This just returns true. The view argument builder will know where to find the argument from. | |
views_handler_argument:: |
function | Default action: empty | |
views_handler_argument:: |
function | Default action: ignore. | |
views_handler_argument:: |
function | Default action: not found. | |
views_handler_argument:: |
function | Default action: summary. | |
views_handler_argument:: |
function | Provide a form for selecting further summary options when the default action is set to display one. | |
views_handler_argument:: |
function | ||
views_handler_argument:: |
function | Generic plugin export handler. | |
views_handler_argument:: |
function | Export handler for summary export. | |
views_handler_argument:: |
function | Export handler for validation export. | |
views_handler_argument:: |
function | Get a default argument, if available. | |
views_handler_argument:: |
function | Get the display or row plugin, if it exists. | |
views_handler_argument:: |
function | Return a description of how the argument would normally be sorted. | |
views_handler_argument:: |
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(). | |
views_handler_argument:: |
function | Get the value of this argument. | |
views_handler_argument:: |
function | Determine if the argument is set to provide a default argument. | |
views_handler_argument:: |
function | ||
views_handler_argument:: |
function |
Determine if the argument needs a style plugin. Overrides views_handler:: |
|
views_handler_argument:: |
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:: |
|
views_handler_argument:: |
function |
Validate the options form. Overrides views_handler:: |
|
views_handler_argument:: |
function | Process the summary arguments for display. | |
views_handler_argument:: |
function | Set the input for this argument | |
views_handler_argument:: |
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. | |
views_handler_argument:: |
function | Some basic summary behavior that doesn't need to be repeated as much as code that goes into summary_query() | |
views_handler_argument:: |
function | Provides the name to use for the summary. By default this is just the name field. | |
views_handler_argument:: |
function | Add the name field, which is the field displayed in summary queries. This is often used when the argument is numeric. | |
views_handler_argument:: |
function | Sorts the summary based upon the user's selection. The base variant of this is usually adequte. | |
views_handler_argument:: |
function | Determine if the argument can generate a breadcrumb | |
views_handler_argument:: |
function | Validate that this argument works. By default, all arguments are valid. | |
views_handler_argument:: |
function | Called by the menu system to validate an argument. | |
views_handler_argument:: |
function | Provide a basic argument validation. | |
views_handler_argument:: |
function | How to act if validation failes | |
views_handler_argument_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_argument_many_to_one:: |
function |
init the handler with necessary data. Overrides views_handler_argument:: |
|
views_handler_argument_many_to_one:: |
function |
Build the options form. Overrides views_handler_argument:: |
|
views_handler_argument_many_to_one:: |
function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides views_handler_argument:: |
|
views_handler_argument_many_to_one:: |
function |
Set up the query for this argument. Overrides views_handler_argument:: |
|
views_handler_argument_many_to_one:: |
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->get_url(). Overrides views_handler_argument:: |
|
views_handler_argument_many_to_one:: |
function |
Build the info for the summary query. Overrides views_handler_argument:: |
|
views_handler_argument_many_to_one:: |
function |
Get the title this argument will assign the view, given the argument. Overrides views_handler_argument:: |
|
views_handler_argument_many_to_one:: |
function | Override for specific title lookups. | |
views_object:: |
function | ||
views_object:: |
function | ||
views_object:: |
function | ||
views_object:: |
function | Always exports the option, regardless of the default value. | |
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 | Unpack a single option definition. | |
views_object:: |
function | Unpacks each handler to store translatable texts. | |
views_object:: |
function |