You are here

Home » API reference » Search API 7 » handler_filter_numeric.inc

class SearchApiViewsHandlerFilterNumeric in Search API 7

Views filter handler class for handling numeric and "string" fields.

Hierarchy

Expanded class hierarchy of SearchApiViewsHandlerFilterNumeric

1 string reference to 'SearchApiViewsHandlerFilterNumeric'
_search_api_views_add_handlers in contrib/search_api_views/search_api_views.views.inc
Adds handler definitions for a field to a Views data table definition.

File

contrib/search_api_views/includes/handler_filter_numeric.inc, line 11
Contains SearchApiViewsHandlerFilterNumeric.

View source 
class SearchApiViewsHandlerFilterNumeric extends SearchApiViewsHandlerFilter {

  /**
   * {@inheritdoc}
   */
  public function init(&$view, &$options) {
    parent::init($view, $options);
    $this
      ->normalizeValue();
  }

  /**
   * {@inheritdoc}
   */
  public function option_definition() {
    $options = parent::option_definition();
    $options['value'] = array(
      'contains' => array(
        'value' => array(
          'default' => '',
        ),
        'min' => array(
          'default' => '',
        ),
        'max' => array(
          'default' => '',
        ),
      ),
    );
    return $options;
  }

  /**
   * {@inheritdoc}
   */
  public function operator_options() {
    $operators = parent::operator_options();
    $index = search_api_index_load(substr($this->table, 17));
    $server = NULL;
    try {
      if ($index) {
        $server = $index
          ->server();
      }
    } catch (SearchApiException $e) {

      // Ignore.
    }
    if ($server && $server
      ->supportsFeature('search_api_between')) {
      $operators += array(
        'between' => t('Is between'),
        'not between' => t('Is not between'),
      );
    }
    return $operators;
  }

  /**
   * Provides a form for setting the filter value.
   *
   * Heavily borrowed from views_handler_filter_numeric.
   *
   * @see views_handler_filter_numeric::value_form()
   */
  public function value_form(&$form, &$form_state) {
    $form['value']['#tree'] = TRUE;
    $single_field_operators = $this
      ->operator_options();
    unset($single_field_operators['empty'], $single_field_operators['not empty'], $single_field_operators['between'], $single_field_operators['not between']);
    $between_operators = array(
      'between',
      'not between',
    );

    // 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';
    $source = NULL;
    if (!empty($form['operator'])) {
      $source = $form['operator']['#type'] == 'radios' ? 'radio:options[operator]' : 'edit-options-operator';
    }
    $identifier = NULL;
    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, $between_operators) ? 'minmax' : 'value';
      }
      else {
        $source = 'edit-' . drupal_html_id($this->options['expose']['operator_id']);
      }
    }

    // Hide the value box if the operator is 'empty' or 'not empty'.
    // Radios share the same selector so we have to add some dummy selector.
    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 => array_keys($single_field_operators),
        ),
      );
      if ($identifier && !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' => isset($this->value['value']) ? $this->value['value'] : '',
      );
      if ($identifier && !isset($form_state['input'][$identifier])) {
        $form_state['input'][$identifier] = isset($this->value['value']) ? $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') {
        $form['value']['min']['#dependency'] = array(
          $source => $between_operators,
        );
        $form['value']['max']['#dependency'] = array(
          $source => $between_operators,
        );
      }
      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']['value'])) {

        // Ensure there is something in the 'value'.
        $form['value']['value'] = array(
          '#type' => 'value',
          '#value' => NULL,
        );
      }
    }
  }

  /**
   * {@inheritdoc}
   */
  public function admin_summary() {
    if (!empty($this->options['exposed'])) {
      return t('exposed');
    }
    if ($this->operator === 'empty') {
      return t('is empty');
    }
    if ($this->operator === 'not empty') {
      return t('is not empty');
    }
    if (in_array($this->operator, array(
      'between',
      'not between',
    ), TRUE)) {

      // This is of course wrong for translation purposes, but copied from
      // views_handler_filter_numeric::admin_summary() so probably still better
      // to re-use this than to do it correctly.
      $operator = $this->operator === 'between' ? t('between') : t('not between');
      $vars = array(
        '@min' => (string) $this->value['min'],
        '@max' => (string) $this->value['max'],
      );
      return $operator . ' ' . t('@min and @max', $vars);
    }
    return check_plain((string) $this->operator) . ' ' . check_plain((string) $this->value['value']);
  }

  /**
   * {@inheritdoc}
   */
  public function query() {
    $this
      ->normalizeValue();
    if (in_array($this->operator, array(
      'between',
      'not between',
    ), TRUE)) {
      $min = $this->value['min'];
      $max = $this->value['max'];
      if ($min !== '' && $max !== '') {
        $this->query
          ->condition($this->real_field, array(
          $min,
          $max,
        ), strtoupper($this->operator), $this->options['group']);
      }
      elseif ($min !== '') {
        $operator = $this->operator === 'between' ? '>=' : '<';
        $this->query
          ->condition($this->real_field, $min, $operator, $this->options['group']);
      }
      elseif ($max !== '') {
        $operator = $this->operator === 'between' ? '<=' : '>';
        $this->query
          ->condition($this->real_field, $max, $operator, $this->options['group']);
      }
    }
    else {

      // The parent handler doesn't expect our value structure, just pass the
      // scalar value instead.
      $this->value = $this->value['value'];
      parent::query();
    }
  }

  /**
   * Sets $this->value to an array of options as defined by the filter.
   *
   * @see SearchApiViewsHandlerFilterNumeric::option_definition()
   */
  protected function normalizeValue() {
    $value = $this->value;
    if (is_array($value) && isset($value[0])) {
      $value = $value[0];
    }
    if (!is_array($value)) {
      $value = array(
        'value' => $value,
      );
    }
    $this->value = array(
      'value' => isset($value['value']) ? $value['value'] : '',
      'min' => isset($value['min']) ? $value['min'] : '',
      'max' => isset($value['max']) ? $value['max'] : '',
    );
  }

}

Members

Namesort descending Modifiers Type Description Overrides
SearchApiViewsHandlerFilter::$operator public property The operator used for filtering. Overrides views_handler_filter::$operator
SearchApiViewsHandlerFilter::$query public property The associated views query object. Overrides views_handler::$query 4
SearchApiViewsHandlerFilter::$value public property The value to filter for. Overrides views_handler_filter::$value
SearchApiViewsHandlerFilterNumeric::admin_summary public function Display the filter on the administrative summary Overrides SearchApiViewsHandlerFilter::admin_summary
SearchApiViewsHandlerFilterNumeric::init public function Provide some extra help to get the operator/value easier to use. Overrides views_handler_filter::init
SearchApiViewsHandlerFilterNumeric::normalizeValue protected function Sets $this->value to an array of options as defined by the filter.
SearchApiViewsHandlerFilterNumeric::operator_options public function Provide a list of options for the operator form. Overrides SearchApiViewsHandlerFilter::operator_options
SearchApiViewsHandlerFilterNumeric::option_definition public function Information about options for all kinds of purposes will be held here. Overrides views_handler_filter::option_definition 1
SearchApiViewsHandlerFilterNumeric::query public function Add this filter to the query. Overrides SearchApiViewsHandlerFilter::query 1
SearchApiViewsHandlerFilterNumeric::value_form public function Provides a form for setting the filter value. Overrides SearchApiViewsHandlerFilter::value_form 1
views_handler::$handler_type public property The type of the handler, for example filter/footer/field.
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 'broken'. 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'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 'extra options' 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 'exposed', 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'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_multiple public property Disable the possibility to force a single value. 6
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::accept_exposed_input public function Check to see if input from the exposed filters should change the behavior. Overrides views_handler::accept_exposed_input 2
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::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'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_object::$definition public property Handler's definition.
views_object::$options public property Except for displays, options for the object will be held here. 1
views_object::altered_option_definition function Collect this handler'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'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