class contextual_range_filter_handler_argument_string_range in Views Contextual Range Filter 7
Argument handler to implement string range arguments.
Hierarchy
- class \views_object
Expanded class hierarchy of contextual_range_filter_handler_argument_string_range
1 string reference to 'contextual_range_filter_handler_argument_string_range'
- contextual_range_filter_views_data_alter in views/
contextual_range_filter.views.inc - Implements hook_views_data_alter().
File
- views/
contextual_range_filter_handler_argument_string_range.inc, line 13 - Definition of contextual_range_filter_handler_argument_string_range.
View source
class contextual_range_filter_handler_argument_string_range extends views_handler_argument_string {
/**
* Define the option.
*/
public function option_definition() {
$options = parent::option_definition();
$options['not'] = array(
'default' => FALSE,
'bool' => TRUE,
);
return $options;
}
/**
* Create the options form.
*/
public function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
$form['description']['#markup'] = t('Contextual string range filter values are taken from the URL.');
$form['more']['#collapsed'] = FALSE;
$form['break_phrase']['#title'] = t('Allow multiple alphabetic ranges');
$form['break_phrase']['#description'] = t('If selected, multiple ranges may be specified by stringing them together with plus signs. Example: <strong>a--f+q--y</strong>');
$form['not'] = array(
'#type' => 'checkbox',
'#title' => t('Exclude'),
'#description' => t('Negate the range. If selected, output matching the specified range(s) will be excluded, rather than included.'),
'#default_value' => !empty($this->options['not']),
'#fieldset' => 'more',
);
}
/**
* Build the query.
*/
public function query($group_by = FALSE) {
$argument = $this->argument;
if (!empty($this->options['transform_dash'])) {
$argument = strtr($argument, '-', ' ');
}
if (!empty($this->options['break_phrase'])) {
views_break_phrase_string($argument, $this);
}
else {
$this->value = array(
$argument,
);
}
$this
->ensure_my_table();
if (!empty($this->definition['many to one'])) {
if (!empty($this->options['glossary'])) {
$this->helper->formula = TRUE;
}
$this->helper
->ensure_my_table();
$this->helper
->add_filter();
return;
}
if (empty($this->options['glossary'])) {
$field = "{$this->table_alias}.{$this->real_field}";
}
else {
$field = $this
->get_formula();
}
contextual_range_filter_build_range_query($this, $field);
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
contextual_range_filter_handler_argument_string_range:: |
public | function |
Create the options form. Overrides views_handler_argument_string:: |
|
contextual_range_filter_handler_argument_string_range:: |
public | function |
Define the option. Overrides views_handler_argument_string:: |
|
contextual_range_filter_handler_argument_string_range:: |
public | function |
Build the query. Overrides views_handler_argument_string:: |
|
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 | Take input from exposed handlers and assign to this handler, if necessary. | 1 |
views_handler:: |
public | function | Check whether current user has access to this handler. | 10 |
views_handler:: |
public | function | Provide text for the administrative summary. | 4 |
views_handler:: |
public | function | Determine if the handler is considered 'broken'. | 6 |
views_handler:: |
public | function | Determine if a handler can be exposed. | 2 |
views_handler:: |
public | function | Transform a string by a certain method. | |
views_handler:: |
public | function | Ensure the main table for this handler is in the query. This is used a lot. | 8 |
views_handler:: |
public | function | Render our chunk of the exposed handler form when selecting. | 1 |
views_handler:: |
public | function | Get information about the exposed form for the form renderer. | 1 |
views_handler:: |
public | function | Submit the exposed handler form. | |
views_handler:: |
public | function | Validate the exposed handler form. | 4 |
views_handler:: |
public | function | Form for exposed handler options. | 2 |
views_handler:: |
public | function | Set new exposed option defaults when exposed setting is flipped on. | 2 |
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 | Validate the options form. | 1 |
views_handler:: |
public | function | Provide defaults for the handler. | |
views_handler:: |
public | function | Provide a form for setting options. | 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. | |
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 | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | 1 |
views_handler:: |
public | function | Returns TRUE if the exposed filter works like a grouped filter. | 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 | Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. | 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 expose/hide button. | 2 |
views_handler:: |
public | function | Shortcut to display the exposed options form. | |
views_handler:: |
public | function | If set to remember exposed input in the session, store it there. | 1 |
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:: |
public | function | Validates the handler against the complete View. | 1 |
views_handler_argument:: |
public | property | ||
views_handler_argument:: |
public | property | The field to use for the name to use in the summary. | |
views_handler_argument:: |
public | property | The table to use for the name, if not the same table as the argument. | |
views_handler_argument:: |
public | property | ||
views_handler_argument:: |
public | property | 1 | |
views_handler_argument:: |
public | function |
Views handlers use a special construct function. Overrides views_object:: |
5 |
views_handler_argument:: |
public | function | Default action: access denied. | |
views_handler_argument:: |
public | function | Handle the default action, which means our argument wasn't present. | |
views_handler_argument:: |
public | function | List of default behaviors for this argument if the argument is not present. | 4 |
views_handler_argument:: |
public | function | Provide a form for selecting the default argument. | 1 |
views_handler_argument:: |
public | function | This just returns true. | |
views_handler_argument:: |
public | function | Default action: empty. | |
views_handler_argument:: |
public | function | Default action: ignore. | |
views_handler_argument:: |
public | function | Default action: not found. | |
views_handler_argument:: |
public | function | Default action: summary. | |
views_handler_argument:: |
public | function | Form for selecting further summary options. | |
views_handler_argument:: |
public | function | Work out which title to use. | |
views_handler_argument:: |
public | function | Generic plugin export handler. | 1 |
views_handler_argument:: |
public | function | Export handler for summary export. | |
views_handler_argument:: |
public | function | Export handler for validation export. | |
views_handler_argument:: |
public | function | Get a default argument, if available. | 1 |
views_handler_argument:: |
public | function | Get the display or row plugin, if it exists. | |
views_handler_argument:: |
public | function | Called by the view object to get the title. | |
views_handler_argument:: |
public | function | Get the value of this argument. | |
views_handler_argument:: |
public | function | Determine if the argument is set to provide a default argument. | |
views_handler_argument:: |
public | function | ||
views_handler_argument:: |
public | function |
Determine if the argument needs a style plugin. Overrides views_handler:: |
|
views_handler_argument:: |
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. Overrides views_handler:: |
|
views_handler_argument:: |
public | function |
Validate the options form. Overrides views_handler:: |
|
views_handler_argument:: |
public | function | Process the summary arguments for display. | |
views_handler_argument:: |
public | function | Set the input for this argument. | |
views_handler_argument:: |
public | function | Give an argument the opportunity to modify the breadcrumb, if it wants. | 3 |
views_handler_argument:: |
public | function | Some basic summary behavior. | |
views_handler_argument:: |
public | function | Add the name field, which is the field displayed in summary queries. | |
views_handler_argument:: |
public | function | Sorts the summary based upon the user's selection. | |
views_handler_argument:: |
public | function | Determine if the argument can generate a breadcrumb. | |
views_handler_argument:: |
public | function | Validate that this argument works. By default, all arguments are valid. | |
views_handler_argument:: |
public | function | Called by the menu system to validate an argument. | |
views_handler_argument:: |
public | function | Provide a basic argument validation. | 1 |
views_handler_argument:: |
public | function | How to act if validation fails. | |
views_handler_argument_string:: |
public | function | Get the formula for this argument. | |
views_handler_argument_string:: |
public | function |
Return a description of how the argument would normally be sorted. Overrides views_handler_argument:: |
|
views_handler_argument_string:: |
public | function |
Init the handler with necessary data. Overrides views_handler_argument:: |
1 |
views_handler_argument_string:: |
public | function |
Provide the argument to use to link from the summary to the next level. Overrides views_handler_argument:: |
|
views_handler_argument_string:: |
public | function |
Provides the name to use for the summary. Overrides views_handler_argument:: |
2 |
views_handler_argument_string:: |
public | function |
Build the summary query based on a string. Overrides views_handler_argument:: |
|
views_handler_argument_string:: |
public | function |
Get the title this argument will assign the view, given the argument. Overrides views_handler_argument:: |
2 |
views_handler_argument_string:: |
public | function | Override for specific title lookups. | |
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 |