Simple filter to handle greater than/less than filters
@PluginID("numeric");
Expanded class hierarchy of Numeric
class Numeric extends FilterPluginBase {
var $always_multiple = TRUE;
protected function defineOptions() {
$options = parent::defineOptions();
$options['value'] = array(
'contains' => array(
'min' => array(
'default' => '',
),
'max' => array(
'default' => '',
),
'value' => array(
'default' => '',
),
),
);
return $options;
}
function operators() {
$operators = array(
'<' => array(
'title' => t('Is less than'),
'method' => 'opSimple',
'short' => t('<'),
'values' => 1,
),
'<=' => array(
'title' => t('Is less than or equal to'),
'method' => 'opSimple',
'short' => t('<='),
'values' => 1,
),
'=' => array(
'title' => t('Is equal to'),
'method' => 'opSimple',
'short' => t('='),
'values' => 1,
),
'!=' => array(
'title' => t('Is not equal to'),
'method' => 'opSimple',
'short' => t('!='),
'values' => 1,
),
'>=' => array(
'title' => t('Is greater than or equal to'),
'method' => 'opSimple',
'short' => t('>='),
'values' => 1,
),
'>' => array(
'title' => t('Is greater than'),
'method' => 'opSimple',
'short' => t('>'),
'values' => 1,
),
'between' => array(
'title' => t('Is between'),
'method' => 'opBetween',
'short' => t('between'),
'values' => 2,
),
'not between' => array(
'title' => t('Is not between'),
'method' => 'opBetween',
'short' => t('not between'),
'values' => 2,
),
);
// 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' => 'opEmpty',
'short' => t('empty'),
'values' => 0,
),
'not empty' => array(
'title' => t('Is not empty (NOT NULL)'),
'method' => 'opEmpty',
'short' => t('not empty'),
'values' => 0,
),
);
}
// Add regexp support for MySQL.
if (Database::getConnection()
->databaseType() == 'mysql') {
$operators += array(
'regular_expression' => array(
'title' => t('Regular expression'),
'short' => t('regex'),
'method' => 'opRegex',
'values' => 1,
),
);
}
return $operators;
}
/**
* Provide a list of all the numeric operators
*/
public function operatorOptions($which = 'title') {
$options = array();
foreach ($this
->operators() as $id => $info) {
$options[$id] = $info[$which];
}
return $options;
}
protected function operatorValues($values = 1) {
$options = array();
foreach ($this
->operators() as $id => $info) {
if ($info['values'] == $values) {
$options[] = $id;
}
}
return $options;
}
/**
* Provide a simple textfield for equality
*/
protected function valueForm(&$form, &$form_state) {
$form['value']['#tree'] = TRUE;
// We have to make some choices when creating this as an exposed
// filter form. For example, if the operator is locked and thus
// not rendered, we can't render dependencies; instead we only
// render the form items we need.
$which = 'all';
if (!empty($form['operator'])) {
$source = ':input[name="options[operator]"]';
}
if (!empty($form_state['exposed'])) {
$identifier = $this->options['expose']['identifier'];
if (empty($this->options['expose']['use_operator']) || empty($this->options['expose']['operator_id'])) {
// exposed and locked.
$which = in_array($this->operator, $this
->operatorValues(2)) ? 'minmax' : 'value';
}
else {
$source = ':input[name="' . $this->options['expose']['operator_id'] . '"]';
}
}
if ($which == 'all') {
$form['value']['value'] = array(
'#type' => 'textfield',
'#title' => empty($form_state['exposed']) ? t('Value') : '',
'#size' => 30,
'#default_value' => $this->value['value'],
);
// Setup #states for all operators with one value.
foreach ($this
->operatorValues(1) as $operator) {
$form['value']['value']['#states']['visible'][] = array(
$source => array(
'value' => $operator,
),
);
}
if (!empty($form_state['exposed']) && !isset($form_state['input'][$identifier]['value'])) {
$form_state['input'][$identifier]['value'] = $this->value['value'];
}
}
elseif ($which == 'value') {
// When exposed we drop the value-value and just do value if
// the operator is locked.
$form['value'] = array(
'#type' => 'textfield',
'#title' => empty($form_state['exposed']) ? t('Value') : '',
'#size' => 30,
'#default_value' => $this->value['value'],
);
if (!empty($form_state['exposed']) && !isset($form_state['input'][$identifier])) {
$form_state['input'][$identifier] = $this->value['value'];
}
}
if ($which == 'all' || $which == 'minmax') {
$form['value']['min'] = array(
'#type' => 'textfield',
'#title' => empty($form_state['exposed']) ? t('Min') : '',
'#size' => 30,
'#default_value' => $this->value['min'],
);
$form['value']['max'] = array(
'#type' => 'textfield',
'#title' => empty($form_state['exposed']) ? t('And max') : t('And'),
'#size' => 30,
'#default_value' => $this->value['max'],
);
if ($which == 'all') {
$states = array();
// Setup #states for all operators with two values.
foreach ($this
->operatorValues(2) as $operator) {
$states['#states']['visible'][] = array(
$source => array(
'value' => $operator,
),
);
}
$form['value']['min'] += $states;
$form['value']['max'] += $states;
}
if (!empty($form_state['exposed']) && !isset($form_state['input'][$identifier]['min'])) {
$form_state['input'][$identifier]['min'] = $this->value['min'];
}
if (!empty($form_state['exposed']) && !isset($form_state['input'][$identifier]['max'])) {
$form_state['input'][$identifier]['max'] = $this->value['max'];
}
if (!isset($form['value'])) {
// Ensure there is something in the 'value'.
$form['value'] = array(
'#type' => 'value',
'#value' => NULL,
);
}
}
}
public function query() {
$this
->ensureMyTable();
$field = "{$this->tableAlias}.{$this->realField}";
$info = $this
->operators();
if (!empty($info[$this->operator]['method'])) {
$this
->{$info[$this->operator]['method']}($field);
}
}
protected function opBetween($field) {
if ($this->operator == 'between') {
$this->query
->addWhere($this->options['group'], $field, array(
$this->value['min'],
$this->value['max'],
), 'BETWEEN');
}
else {
$this->query
->addWhere($this->options['group'], db_or()
->condition($field, $this->value['min'], '<=')
->condition($field, $this->value['max'], '>='));
}
}
protected function opSimple($field) {
$this->query
->addWhere($this->options['group'], $field, $this->value['value'], $this->operator);
}
protected function opEmpty($field) {
if ($this->operator == 'empty') {
$operator = "IS NULL";
}
else {
$operator = "IS NOT NULL";
}
$this->query
->addWhere($this->options['group'], $field, NULL, $operator);
}
protected function opRegex($field) {
$this->query
->addWhere($this->options['group'], $field, $this->value, 'RLIKE');
}
public function adminSummary() {
if ($this
->isAGroup()) {
return t('grouped');
}
if (!empty($this->options['exposed'])) {
return t('exposed');
}
$options = $this
->operatorOptions('short');
$output = check_plain($options[$this->operator]);
if (in_array($this->operator, $this
->operatorValues(2))) {
$output .= ' ' . t('@min and @max', array(
'@min' => $this->value['min'],
'@max' => $this->value['max'],
));
}
elseif (in_array($this->operator, $this
->operatorValues(1))) {
$output .= ' ' . check_plain($this->value['value']);
}
return $output;
}
/**
* Do some minor translation of the exposed input
*/
public function acceptExposedInput($input) {
if (empty($this->options['exposed'])) {
return TRUE;
}
// rewrite the input value so that it's in the correct format so that
// the parent gets the right data.
if (!empty($this->options['expose']['identifier'])) {
$value =& $input[$this->options['expose']['identifier']];
if (!is_array($value)) {
$value = array(
'value' => $value,
);
}
}
$rc = parent::acceptExposedInput($input);
if (empty($this->options['expose']['required'])) {
// We have to do some of our own checking for non-required filters.
$info = $this
->operators();
if (!empty($info[$this->operator]['values'])) {
switch ($info[$this->operator]['values']) {
case 1:
if ($value['value'] === '') {
return FALSE;
}
break;
case 2:
if ($value['min'] === '' && $value['max'] === '') {
return FALSE;
}
break;
}
}
}
return $rc;
}
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
Numeric:: |
function | |||
Numeric:: |
protected | function | ||
Numeric:: |
protected | function | 2 | |
Numeric:: |
protected | function | 2 | |
Numeric:: |
protected | function | 1 | |
Numeric:: |
protected | function | ||
FilterPluginBase:: |
public | function | ||
HandlerBase:: |
public | function | A submit handler that is used for storing temporary items when using multi-step changes, such as ajax requests. | |
FilterPluginBase:: |
public | function | Add a new group to the exposed filter groups. | |
Numeric:: |
public | function |
Add this filter to the query. Overrides FilterPluginBase:: |
3 |
PluginBase:: |
public | function | Adds elements for available core tokens to a form. | |
HandlerBase:: |
public static | function | Breaks x,y,z and x+y+z into an array. Numeric only. | |
HandlerBase:: |
public static | function | Breaks x,y,z and x+y+z into an array. Works for strings. | |
FilterPluginBase:: |
public | function | Build a form containing a group of operator | values to apply as a single filter. | |
FilterPluginBase:: |
protected | function | Build the form to let users create the group of exposed filters. This form is displayed when users click on button 'Build group' | |
HandlerBase:: |
public | function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
FilterPluginBase:: |
public | function | Can this filter be used in OR groups? | 1 |
HandlerBase:: |
public | function | Check whether current user has access to this handler. | 6 |
PluginBase:: |
public | function | Clears a plugin. | 2 |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
HandlerBase:: |
public | function |
Constructs a Handler object. Overrides PluginBase:: |
3 |
FilterPluginBase:: |
property | Contains the actual value of the field,either configured in the views ui or entered in the exposed filters. | ||
FilterPluginBase:: |
property | Contains the information of the selected item in a gruped filter. | ||
FilterPluginBase:: |
property | Contains the operator which is used on the query. | ||
ContainerFactoryPluginBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
11 |
HandlerBase:: |
public | function | Creates cross-database SQL date formatting. | |
HandlerBase:: |
public | function | Creates cross-database SQL dates. | |
PluginBase:: |
protected | property | Denotes whether the plugin has an additional options form. | 8 |
FilterPluginBase:: |
protected | function | Determine if a filter can be converted into a group. Only exposed filters with operators available can be converted into groups. | |
FilterPluginBase:: |
public | function |
Determine if a filter can be exposed. Overrides HandlerBase:: |
2 |
HandlerBase:: |
public | function | Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. | 6 |
HandlerBase:: |
public | function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
HandlerBase:: |
public | function | Determines the entity type used by this handler. | |
FilterPluginBase:: |
property | Disable the possibility to allow a exposed input to be optional. | ||
Numeric:: |
property |
Disable the possibility to force a single value. Overrides FilterPluginBase:: |
||
FilterPluginBase:: |
property | Disable the possibility to use operators. | 2 | |
Numeric:: |
public | function |
Display the filter on the administrative summary Overrides FilterPluginBase:: |
|
FilterPluginBase:: |
public | function | Displays the Build Group form. | |
HandlerBase:: |
public | function | Displays the Expose form. | |
Numeric:: |
public | function |
Do some minor translation of the exposed input Overrides FilterPluginBase:: |
1 |
HandlerBase:: |
public | function | Ensure the main table for this handler is in the query. This is used a lot. | 8 |
HandlerBase:: |
public static | function | Fetches a handler to join one table to a primary table from the data cache. | |
PluginBase:: |
protected | function | Fills up the options of the plugin with defaults. | |
FilterPluginBase:: |
protected static | function | Filter by no empty values, though allow to use "0". | |
HandlerBase:: |
public | function | Get the join object that should be used for this handler. | |
HandlerBase:: |
public | function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | 1 |
FilterPluginBase:: |
public | function | If set to remember exposed input in the session, store it there. This function is similar to storeExposedInput but modified to work properly when the filter is a group. | |
FilterPluginBase:: |
public | function |
If set to remember exposed input in the session, store it there. Overrides HandlerBase:: |
|
Numeric:: |
protected | function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides FilterPluginBase:: |
4 |
FilterPluginBase:: |
protected | function | Make some translations to a form item to make it more suitable to exposing. | |
PluginBase:: |
public | property | Options for this plugin will be held here. | |
FilterPluginBase:: |
public | function |
Options form subform for exposed filter options. Overrides HandlerBase:: |
2 |
FilterPluginBase:: |
protected | function | Options form subform for setting the operator. | 4 |
FilterPluginBase:: |
public | function |
Overrides \Drupal\views\Plugin\views\HandlerBase::init(). Overrides HandlerBase:: |
3 |
HandlerBase:: |
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. | |
FilterPluginBase:: |
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. | |
FilterPluginBase:: |
protected | 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 |
HandlerBase:: |
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 |
HandlerBase:: |
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. | |
PluginBase:: |
public | property | Plugins's definition | |
HandlerBase:: |
public | function | Provide a form for aggregation settings. | 1 |
HandlerBase:: |
public | function | Provide a form for setting options. | 1 |
PluginBase:: |
public | function | Provide a full list of possible theme templates used by this style. | 1 |
Numeric:: |
public | function |
Provide a list of all the numeric operators Overrides FilterPluginBase:: |
|
Numeric:: |
protected | function |
Provide a simple textfield for equality Overrides FilterPluginBase:: |
1 |
FilterPluginBase:: |
public | function |
Provide default options for exposed filters. Overrides HandlerBase:: |
2 |
FilterPluginBase:: |
protected | function | Provide default options for exposed filters. | |
HandlerBase:: |
public | function | Provide defaults for the handler. | |
FilterPluginBase:: |
public | 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 HandlerBase:: |
3 |
HandlerBase:: |
protected | function | Provides a unique placeholders for handlers. | |
HandlerBase:: |
public | function | Provides the handler some groupby. | 2 |
FilterPluginBase:: |
public | function |
Render our chunk of the exposed filter form when selecting Overrides HandlerBase:: |
|
HandlerBase:: |
public | function | Return a string representing this handler's name in the UI. | 9 |
PluginBase:: |
public | function | Return the human readable name of the display. | |
PluginBase:: |
public | function | Returns a string with any core tokens replaced. | |
PluginBase:: |
public | function | Returns an array of available token replacements. | |
PluginBase:: |
public | function |
Returns the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
|
FilterPluginBase:: |
public | function | Returns the options available for a grouped filter that users checkboxes as widget, and therefore has to be applied several times, one per item selected. | |
PluginBase:: |
public | function |
Returns the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Returns the summary of the settings in the display. | 6 |
PluginBase:: |
public | function | Returns the usesOptions property. | 8 |
FilterPluginBase:: |
public | function |
Returns TRUE if the exposed filter works like a grouped filter. Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function |
Returns TRUE if users can select multiple groups items of a
grouped exposed filter. Overrides HandlerBase:: |
|
HandlerBase:: |
public | function | Run after the view is executed, before the result is cached. | |
HandlerBase:: |
public | function | Run before the view is built. | 1 |
HandlerBase:: |
public | function | Sanitize the value for output. | |
FilterPluginBase:: |
protected | function | Sanitizes the HTML select element's options. | |
FilterPluginBase:: |
protected | function | Save new group items, re-enumerates and remove groups marked to delete. | |
FilterPluginBase:: |
protected | function | Shortcut to display the build_group/hide button. | |
FilterPluginBase:: |
public | function |
Shortcut to display the expose/hide button. Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function | Shortcut to display the exposed options form. | |
HandlerBase:: |
public | function | Shortcut to display the exposed options form. | |
FilterPluginBase:: |
public | function | Shortcut to display the operator form. | |
FilterPluginBase:: |
protected | function | Shortcut to display the value form. | |
HandlerBase:: |
public | function | Shortcut to get a handler's raw field value. | |
FilterPluginBase:: |
public | function |
Simple submit handler Overrides HandlerBase:: |
|
FilterPluginBase:: |
public | function |
Simple validate handler Overrides HandlerBase:: |
1 |
HandlerBase:: |
public | function | Submit the exposed handler form | |
FilterPluginBase:: |
public | function |
Tell the renderer about our exposed form. This only needs to be
overridden for particularly complex forms. And maybe not even then. Overrides HandlerBase:: |
|
HandlerBase:: |
public | property | The actual field in the database table, maybe different on other kind of query plugins/special handlers. | |
HandlerBase:: |
public | property | The alias of the table of this handler which is used in the query. | |
PluginBase:: |
public | property | The display object this plugin is for. | |
PluginBase:: |
protected | property | The plugin implementation definition. | |
PluginBase:: |
protected | property | The plugin_id. | |
HandlerBase:: |
public | property | The relationship used for this field. | |
HandlerBase:: |
public | property | The table this handler is attached to. | |
PluginBase:: |
public | property | The top object of a view. | 1 |
HandlerBase:: |
protected | function | Transform a string by a certain method. | |
PluginBase:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
FilterPluginBase:: |
protected | function | Validate the build group options form. | 1 |
HandlerBase:: |
public | function | Validate the exposed handler form | 4 |
FilterPluginBase:: |
protected | function | Validate the operator form. | |
FilterPluginBase:: |
protected | function | Validate the options form. | 3 |
FilterPluginBase:: |
public | function |
Validate the options form. Overrides HandlerBase:: |
|
HandlerBase:: |
public | function | Validate the options form. | |
HandlerBase:: |
public | function |
Validates the handler against the complete View. Overrides PluginBase:: |
1 |
HandlerBase:: |
public | property | When a field has been moved this property is set. | |
HandlerBase:: |
public | property | When a table has been moved this property is set. | |
HandlerBase:: |
public | property | Where the $query object will reside: | 1 |
HandlerBase:: |
public | property | With field you can override the realField if the real field is not set. |