class views_handler_filter_numeric

Simple filter to handle greater than/less than filters.

Hierarchy

Expanded class hierarchy of views_handler_filter_numeric

Related topics

14 string references to 'views_handler_filter_numeric'
aggregator_views_data in modules/aggregator.views.inc
Implements hook_views_data().
book_views_data in modules/book.views.inc
Implements hook_views_data().
comment_views_data in modules/comment.views.inc
Implements hook_views_data().
field_views_field_default_views_data in modules/field.views.inc
Default views data implementation for a field.
hook_views_data in ./views.api.php
Describes data tables (or the equivalent) to Views.

... See full list

File

handlers/views_handler_filter_numeric.inc, line 13

View source
class views_handler_filter_numeric extends views_handler_filter {
    
    /**
     * Exposed filter options.
     */
    public $always_multiple = TRUE;
    
    /**
     * {@inheritdoc}
     */
    public function option_definition() {
        $options = parent::option_definition();
        $options['value'] = array(
            'contains' => array(
                'min' => array(
                    'default' => '',
                ),
                'max' => array(
                    'default' => '',
                ),
                'value' => array(
                    'default' => '',
                ),
            ),
        );
        return $options;
    }
    
    /**
     * {@inheritdoc}
     */
    public function operators() {
        $operators = array(
            '<' => array(
                'title' => t('Is less than'),
                'method' => 'op_simple',
                'short' => t('<'),
                'values' => 1,
            ),
            '<=' => array(
                'title' => t('Is less than or equal to'),
                'method' => 'op_simple',
                'short' => t('<='),
                'values' => 1,
            ),
            '=' => array(
                'title' => t('Is equal to'),
                'method' => 'op_simple',
                'short' => t('='),
                'values' => 1,
            ),
            '!=' => array(
                'title' => t('Is not equal to'),
                'method' => 'op_simple',
                'short' => t('!='),
                'values' => 1,
            ),
            '>=' => array(
                'title' => t('Is greater than or equal to'),
                'method' => 'op_simple',
                'short' => t('>='),
                'values' => 1,
            ),
            '>' => array(
                'title' => t('Is greater than'),
                'method' => 'op_simple',
                'short' => t('>'),
                'values' => 1,
            ),
            'between' => array(
                'title' => t('Is between'),
                'method' => 'op_between',
                'short' => t('between'),
                'values' => 2,
            ),
            'not between' => array(
                'title' => t('Is not between'),
                'method' => 'op_between',
                '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' => '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,
                ),
            );
        }
        // Add regexp support for MySQL.
        if (Database::getConnection()->databaseType() == 'mysql') {
            $operators += array(
                'regular_expression' => array(
                    'title' => t('Regular expression'),
                    'short' => t('regex'),
                    'method' => 'op_regex',
                    'values' => 1,
                ),
                'not_regular_expression' => array(
                    'title' => t('Not regular expression'),
                    'short' => t('not regex'),
                    'method' => 'op_not_regex',
                    'values' => 1,
                ),
            );
        }
        return $operators;
    }
    
    /**
     * Provide a list of all the numeric operators.
     */
    public function operator_options($which = 'title') {
        $options = array();
        foreach ($this->operators() as $id => $info) {
            $options[$id] = $info[$which];
        }
        return $options;
    }
    
    /**
     * {@inheritdoc}
     */
    public function operator_values($values = 1) {
        $options = array();
        foreach ($this->operators() as $id => $info) {
            if ($info['values'] == $values) {
                $options[] = $id;
            }
        }
        return $options;
    }
    
    /**
     * Provide a simple textfield for equality.
     */
    public function value_form(&$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';
        $limit_operators = !empty($this->options['expose']['limit_operators']) && count($this->options['expose']['available_operators']) > 0;
        $use_value = FALSE;
        $use_minmax = FALSE;
        if (!empty($form['operator'])) {
            $source = $form['operator']['#type'] == 'radios' ? 'radio:options[operator]' : 'edit-options-operator';
        }
        if (!empty($form_state['exposed'])) {
            $operator_values_with_1_values = $this->operator_values(1);
            $operator_values_with_2_values = $this->operator_values(2);
            if ($limit_operators) {
                // If limit operators is enabled, check that at least one operator
                // with two values is enabled to display the min max widgets.
                foreach ($operator_values_with_2_values as $operator) {
                    if (isset($this->options['expose']['available_operators'][$operator])) {
                        $use_minmax = TRUE;
                        break;
                    }
                }
                // The same for operators with one value.
                foreach ($operator_values_with_1_values as $operator) {
                    if (isset($this->options['expose']['available_operators'][$operator])) {
                        $use_value = TRUE;
                        break;
                    }
                }
            }
            else {
                $use_minmax = $use_value = TRUE;
            }
            $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, $operator_values_with_2_values) ? 'minmax' : 'value';
            }
            else {
                $source = 'edit-' . drupal_html_id($this->options['expose']['operator_id']);
            }
        }
        else {
            $use_minmax = $use_value = TRUE;
        }
        if ($use_value) {
            if ($which == 'all') {
                $form['value']['value'] = array(
                    '#type' => 'textfield',
                    '#title' => empty($form_state['exposed']) ? t('Value') : '',
                    '#size' => 30,
                    '#default_value' => $this->value['value'],
                    '#dependency' => array(
                        $source => $this->operator_values(1),
                    ),
                );
                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') {
            if ($use_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') {
                    $dependency = array(
                        '#dependency' => array(
                            $source => $this->operator_values(2),
                        ),
                    );
                    $form['value']['min'] += $dependency;
                    $form['value']['max'] += $dependency;
                }
            }
            if (!empty($form_state['exposed']) && !isset($form_state['input'][$identifier]['min']) && $use_minmax) {
                $form_state['input'][$identifier]['min'] = $this->value['min'];
            }
            if (!empty($form_state['exposed']) && !isset($form_state['input'][$identifier]['max']) && $use_minmax) {
                $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,
                );
            }
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function query() {
        $this->ensure_my_table();
        $field = "{$this->table_alias}.{$this->real_field}";
        $info = $this->operators();
        if (!empty($info[$this->operator]['method'])) {
            $this->{$info[$this->operator]['method']}($field);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function op_between($field) {
        if ($this->operator == 'between') {
            $this->query
                ->add_where($this->options['group'], $field, array(
                $this->value['min'],
                $this->value['max'],
            ), 'BETWEEN');
        }
        else {
            $this->query
                ->add_where($this->options['group'], db_or()->condition($field, $this->value['min'], '<=')
                ->condition($field, $this->value['max'], '>='));
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function op_simple($field) {
        $this->query
            ->add_where($this->options['group'], $field, $this->value['value'], $this->operator);
    }
    
    /**
     * {@inheritdoc}
     */
    public function op_empty($field) {
        if ($this->operator == 'empty') {
            $operator = "IS NULL";
        }
        else {
            $operator = "IS NOT NULL";
        }
        $this->query
            ->add_where($this->options['group'], $field, NULL, $operator);
    }
    
    /**
     * {@inheritdoc}
     */
    public function op_regex($field) {
        $this->query
            ->add_where($this->options['group'], $field, $this->value['value'], 'RLIKE');
    }
    
    /**
     * {@inheritdoc}
     */
    public function op_not_regex($field) {
        $this->query
            ->add_where($this->options['group'], $field, $this->value['value'], 'NOT RLIKE');
    }
    
    /**
     * {@inheritdoc}
     */
    public function admin_summary() {
        if ($this->is_a_group()) {
            return t('grouped');
        }
        if (!empty($this->options['exposed'])) {
            return t('exposed');
        }
        $options = $this->operator_options('short');
        $output = check_plain($options[$this->operator]);
        if (in_array($this->operator, $this->operator_values(2))) {
            $output .= ' ' . t('@min and @max', array(
                '@min' => $this->value['min'],
                '@max' => $this->value['max'],
            ));
        }
        elseif (in_array($this->operator, $this->operator_values(1))) {
            $output .= ' ' . check_plain($this->value['value']);
        }
        return $output;
    }
    
    /**
     * Do some minor translation of the exposed input.
     */
    public function accept_exposed_input($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,
                );
            }
            if (!empty($this->options['expose']['use_operator']) && !empty($this->options['expose']['operator_id']) && isset($input[$this->options['expose']['operator_id']])) {
                if ($input[$this->options['expose']['operator_id']] === 'empty' || $input[$this->options['expose']['operator_id']] === 'not empty') {
                    // Parent method will expect a boolean value. We don't ask for a value
                    // so we'll force "Yes".
                    $value['value'] = 1;
                }
            }
        }
        $rc = parent::accept_exposed_input($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']) && is_array($value)) {
                switch ($info[$this->operator]['values']) {
                    case 1:
                        if (array_key_exists('value', $value) && $value['value'] === '') {
                            return FALSE;
                        }
                        break;
                    case 2:
                        if (array_key_exists('min', $value) && $value['min'] === '' && array_key_exists('max', $value) && $value['max'] === '') {
                            return FALSE;
                        }
                        break;
                }
            }
        }
        return $rc;
    }

}

Members

Title Sort descending Deprecated Modifiers Object type Summary Overriden Title Overrides
views_handler::$handler_type public property The type of the handler, for example filter/footer/field.
views_handler::$query public property Where the $query object will reside:. 1
views_handler::$real_field public property The actual field in the database table, maybe different
on other kind of query plugins/special handlers.
views_handler::$relationship public property The relationship used for this field.
views_handler::$table_alias public property The alias of the table of this handler which is used in the query.
views_handler::$view public property The top object of a view. Overrides views_object::$view
views_handler::access public function Check whether current user has access to this handler. 10
views_handler::broken public function Determine if the handler is considered &#039;broken&#039;. 6
views_handler::case_transform public function Transform a string by a certain method.
views_handler::ensure_my_table public function Ensure the main table for this handler is in the query. This is used
a lot.
8
views_handler::exposed_submit public function Submit the exposed handler form.
views_handler::exposed_validate public function Validate the exposed handler form. 4
views_handler::expose_submit 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::extra_options public function Provide defaults for the handler.
views_handler::extra_options_form public function Provide a form for setting options. 1
views_handler::extra_options_submit 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::extra_options_validate public function Validate the options form.
views_handler::get_field public function Shortcut to get a handler&#039;s raw field value.
views_handler::get_join public function Get the join object that should be used for this handler.
views_handler::groupby_form public function Provide a form for aggregation settings. 1
views_handler::groupby_form_submit 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::has_extra_options public function If a handler has &#039;extra options&#039; it will get a little settings widget and
another form called extra_options.
1
views_handler::is_exposed public function Determine if this item is &#039;exposed&#039;, meaning it provides form elements
to let users modify the view.
views_handler::needs_style_plugin public function Determine if the argument needs a style plugin. 1
views_handler::placeholder public function Provides a unique placeholders for handlers.
views_handler::post_execute public function Run after the view is executed, before the result is cached. 1
views_handler::pre_query public function Run before the view is built. 1
views_handler::sanitize_value public function Sanitize the value for output.
views_handler::set_relationship public function Called just prior to query(), this lets a handler set up any relationship
it needs.
views_handler::show_expose_form public function Shortcut to display the exposed options form.
views_handler::ui_name public function Return a string representing this handler&#039;s name in the UI. 9
views_handler::use_group_by public function Provides the handler some groupby. 2
views_handler::validate public function Validates the handler against the complete View. 1
views_handler_filter::$always_required public property Disable the possibility to allow a exposed input to be optional.
views_handler_filter::$group_info public property Contains the information of the selected item in a gruped filter.
views_handler_filter::$no_operator public property Disable the possibility to use operators. 2
views_handler_filter::$operator public property Contains the operator which is used on the query.
views_handler_filter::$value public property Contains the actual value of the field.
views_handler_filter::build_group_form public function Build the form to let users create the group of exposed filters.
views_handler_filter::build_group_options public function Provide default options for exposed filters.
views_handler_filter::build_group_submit public function Save new group items, re-enumerates and remove groups marked to delete.
views_handler_filter::build_group_validate public function Validate the build group options form. 1
views_handler_filter::can_build_group public function Determine if a filter can be converted into a group.
views_handler_filter::can_expose public function Determine if a filter can be exposed. Overrides views_handler::can_expose 5
views_handler_filter::can_group public function Can this filter be used in OR groups? 1
views_handler_filter::convert_exposed_input public function Transform the input from a grouped filter into a standard filter.
views_handler_filter::exposed_form public function Render our chunk of the exposed filter form when selecting. Overrides views_handler::exposed_form
views_handler_filter::exposed_info public function Tell the renderer about our exposed form. Overrides views_handler::exposed_info
views_handler_filter::exposed_translate public function Make some translations to a form item to make it more suitable to exposing.
views_handler_filter::expose_form public function Options form subform for exposed filter options. Overrides views_handler::expose_form 2
views_handler_filter::expose_options public function Provide default options for exposed filters. Overrides views_handler::expose_options 2
views_handler_filter::expose_validate public function Validate the options form. Overrides views_handler::expose_validate
views_handler_filter::group_form public function Build a form with a group of operator | values to apply as a single filter.
views_handler_filter::group_multiple_exposed_input public function Options available for a grouped filter which uses checkboxes.
views_handler_filter::init public function Provide some extra help to get the operator/value easier to use. Overrides views_handler::init 2
views_handler_filter::is_a_group public function Returns TRUE if the exposed filter works like a grouped filter. Overrides views_handler::is_a_group
views_handler_filter::multiple_exposed_input public function Indicate whether users can select multiple group items. Overrides views_handler::multiple_exposed_input
views_handler_filter::operator_form public function Options form subform for setting the operator. 6
views_handler_filter::operator_submit public function Perform any necessary changes to the form values prior to storage.
views_handler_filter::operator_validate public function Validate the operator form.
views_handler_filter::options_form public function Provide the basic form which calls through to subforms. Overrides views_handler::options_form 4
views_handler_filter::options_submit public function Simple submit handler. Overrides views_handler::options_submit
views_handler_filter::options_validate public function Simple validate handler. Overrides views_handler::options_validate 1
views_handler_filter::prepare_filter_select_options public function Sanitizes the HTML select element&#039;s options.
views_handler_filter::show_build_group_button public function Shortcut to display the build_group/hide button.
views_handler_filter::show_build_group_form public function Shortcut to display the exposed options form.
views_handler_filter::show_expose_button public function Shortcut to display the expose/hide button. Overrides views_handler::show_expose_button
views_handler_filter::show_operator_form public function Shortcut to display the operator form.
views_handler_filter::show_value_form public function Shortcut to display the value form.
views_handler_filter::store_exposed_input public function Store the exposed input for processing later. Overrides views_handler::store_exposed_input
views_handler_filter::store_group_input public function If set to remember exposed input in the session, store it there.
views_handler_filter::value_submit public function Perform any necessary changes to the form values prior to storage. 1
views_handler_filter::value_validate public function Validate the options form. 3
views_handler_filter_numeric::$always_multiple public property Exposed filter options. Overrides views_handler_filter::$always_multiple
views_handler_filter_numeric::accept_exposed_input public function Do some minor translation of the exposed input. Overrides views_handler_filter::accept_exposed_input 1
views_handler_filter_numeric::admin_summary public function Display the filter on the administrative summary. Overrides views_handler_filter::admin_summary
views_handler_filter_numeric::operators public function
views_handler_filter_numeric::operator_options public function Provide a list of all the numeric operators. Overrides views_handler_filter::operator_options
views_handler_filter_numeric::operator_values public function
views_handler_filter_numeric::option_definition public function Information about options for all kinds of purposes will be held here. Overrides views_handler_filter::option_definition 1
views_handler_filter_numeric::op_between public function 3
views_handler_filter_numeric::op_empty public function 2
views_handler_filter_numeric::op_not_regex public function
views_handler_filter_numeric::op_regex public function 1
views_handler_filter_numeric::op_simple public function 3
views_handler_filter_numeric::query public function Add this filter to the query. Overrides views_handler_filter::query 2
views_handler_filter_numeric::value_form public function Provide a simple textfield for equality. Overrides views_handler_filter::value_form 1
views_object::$definition public property Handler&#039;s definition.
views_object::$options public property Except for displays, options for the object will be held here. 1
views_object::altered_option_definition public function Collect this handler&#039;s option definition and alter them, ready for use.
views_object::construct public function Views handlers use a special construct function. 4
views_object::destroy public function Destructor. 2
views_object::export_option public function 1
views_object::export_options public function
views_object::export_option_always public function Always exports the option, regardless of the default value.
views_object::options Deprecated public function Set default options on this object. 1
views_object::set_default_options public function Set default options.
views_object::set_definition public function Let the handler know what its full definition is.
views_object::unpack_options public function Unpack options over our existing defaults, drilling down into arrays so
that defaults don&#039;t get totally blown away.
views_object::unpack_translatable public function Unpack a single option definition.
views_object::unpack_translatables public function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults public function