You are here

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

class SearchApiViewsHandlerFilterOptions in Search API 7

Views filter handler for fields with a limited set of possible values.

Hierarchy

Expanded class hierarchy of SearchApiViewsHandlerFilterOptions

1 string reference to 'SearchApiViewsHandlerFilterOptions'
_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_options.inc, line 11
Contains the SearchApiViewsHandlerFilterOptions class.

View source 
class SearchApiViewsHandlerFilterOptions extends SearchApiViewsHandlerFilter {

  /**
   * Stores the values which are available on the form.
   *
   * @var array
   */
  protected $value_options = NULL;

  /**
   * The type of form element used to display the options.
   *
   * @var string
   */
  protected $value_form_type = 'checkboxes';

  /**
   * Retrieves a wrapper for this filter's field.
   *
   * @return EntityMetadataWrapper|null
   *   A wrapper for the field which this filter uses.
   */
  protected function get_wrapper() {
    if ($this->query) {
      $index = $this->query
        ->getIndex();
    }
    elseif (substr($this->view->base_table, 0, 17) == 'search_api_index_') {
      $index = search_api_index_load(substr($this->view->base_table, 17));
    }
    else {
      return NULL;
    }
    $wrapper = $index
      ->entityWrapper(NULL, TRUE);
    $parts = explode(':', $this->real_field);
    foreach ($parts as $i => $part) {
      if (!isset($wrapper->{$part})) {
        return NULL;
      }
      $wrapper = $wrapper->{$part};
      $info = $wrapper
        ->info();
      if ($i < count($parts) - 1) {

        // Unwrap lists.
        $level = search_api_list_nesting_level($info['type']);
        for ($j = 0; $j < $level; ++$j) {
          $wrapper = $wrapper[0];
        }
      }
    }
    return $wrapper;
  }

  /**
   * Fills the value_options property with all possible options.
   */
  protected function get_value_options() {
    if (isset($this->value_options)) {
      return;
    }
    $wrapper = $this
      ->get_wrapper();
    if ($wrapper) {
      $this->value_options = $wrapper
        ->optionsList('view');
    }
    else {
      $this->value_options = array();
    }
  }

  /**
   * Provide a list of options for the operator form.
   */
  public function operator_options() {
    $options = array(
      '=' => t('Is one of'),
      'all of' => t('Is all of'),
      '<>' => t('Is none of'),
      'empty' => t('Is empty'),
      'not empty' => t('Is not empty'),
    );

    // "Is all of" doesn't make sense for single-valued fields.
    if (empty($this->definition['multi-valued'])) {
      unset($options['all of']);
    }
    return $options;
  }

  /**
   * Set "reduce" option to FALSE by default.
   */
  public function expose_options() {
    parent::expose_options();
    $this->options['expose']['reduce'] = FALSE;
  }

  /**
   * Add the "reduce" option to the exposed form.
   */
  public function expose_form(&$form, &$form_state) {
    parent::expose_form($form, $form_state);
    $form['expose']['reduce'] = array(
      '#type' => 'checkbox',
      '#title' => t('Limit list to selected items'),
      '#description' => t('If checked, the only items presented to the user will be the ones selected here.'),
      '#default_value' => !empty($this->options['expose']['reduce']),
    );
  }

  /**
   * Define "reduce" option.
   */
  public function option_definition() {
    $options = parent::option_definition();
    $options['value'] = array(
      'default' => '',
    );
    $options['expose']['contains']['reduce'] = array(
      'default' => FALSE,
    );
    return $options;
  }

  /**
   * Reduce the options according to the selection.
   */
  protected function reduce_value_options() {
    foreach ($this->value_options as $id => $option) {
      if (!isset($this->options['value'][$id])) {
        unset($this->value_options[$id]);
      }
    }
    return $this->value_options;
  }

  /**
   * Save set checkboxes.
   */
  public function value_submit($form, &$form_state) {

    // Drupal's FAPI system automatically puts '0' in for any checkbox that
    // was not set, and the key to the checkbox if it is set.
    // Unfortunately, this means that if the key to that checkbox is 0,
    // we are unable to tell if that checkbox was set or not.
    // Luckily, the '#value' on the checkboxes form actually contains
    // *only* a list of checkboxes that were set, and we can use that
    // instead.
    $form_state['values']['options']['value'] = $form['value']['#value'];
  }

  /**
   * Provide a form for setting options.
   */
  public function value_form(&$form, &$form_state) {
    $this
      ->get_value_options();
    if (!empty($this->options['expose']['reduce']) && !empty($form_state['exposed'])) {
      $options = $this
        ->reduce_value_options();
    }
    else {
      $options = $this->value_options;
    }
    $form['value'] = array(
      '#type' => $this->value_form_type,
      '#title' => empty($form_state['exposed']) ? t('Value') : '',
      '#options' => $options,
      '#multiple' => TRUE,
      '#size' => min(4, count($options)),
      '#default_value' => is_array($this->value) ? $this->value : array(),
    );

    // 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 (empty($form_state['exposed'])) {
      $form['value']['#states']['visible'] = array(
        ':input[name="options[operator]"],dummy-empty' => array(
          '!value' => 'empty',
        ),
        ':input[name="options[operator]"],dummy-not-empty' => array(
          '!value' => 'not empty',
        ),
      );
    }
    elseif (!empty($this->options['expose']['use_operator'])) {
      $name = $this->options['expose']['operator_id'];
      $form['value']['#states']['visible'] = array(
        ':input[name="' . $name . '"],dummy-empty' => array(
          '!value' => 'empty',
        ),
        ':input[name="' . $name . '"],dummy-not-empty' => array(
          '!value' => 'not empty',
        ),
      );
    }
  }

  /**
   * Provides a summary of this filter's value for the admin UI.
   */
  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 (!is_array($this->value)) {
      return;
    }
    $operator_options = $this
      ->operator_options();
    $operator = $operator_options[$this->operator];
    $values = '';

    // Remove every element which is not known.
    $this
      ->get_value_options();
    foreach ($this->value as $i => $value) {
      if (!isset($this->value_options[$value])) {
        unset($this->value[$i]);
      }
    }

    // Choose different kind of ouput for 0, a single and multiple values.
    if (count($this->value) == 0) {
      return $this->operator != '<>' ? t('none') : t('any');
    }
    elseif (count($this->value) == 1) {
      switch ($this->operator) {
        case '=':
        case 'all of':
          $operator = '=';
          break;
        case '<>':
          $operator = '<>';
          break;
      }

      // If there is only a single value, use just the plain operator, = or <>.
      $operator = check_plain($operator);
      $values = check_plain($this->value_options[reset($this->value)]);
    }
    else {
      foreach ($this->value as $value) {
        if ($values !== '') {
          $values .= ', ';
        }
        if (drupal_strlen($values) > 20) {
          $values .= '…';
          break;
        }
        $values .= check_plain($this->value_options[$value]);
      }
    }
    return $operator . ($values !== '' ? ' ' . $values : '');
  }

  /**
   * {@inheritdoc}
   */
  function accept_exposed_input($input) {
    $accepted = parent::accept_exposed_input($input);

    // Grouped filters will have the raw form values structure from the
    // checkboxes as the value here. Convert that into the correct array of
    // values instead.
    if ($accepted && is_array($this->value) && $this
      ->is_a_group()) {

      // For some reason, Views thinks it's a good idea to nest the form values
      // into a second array in some cases. That one will be numerically indexed
      // with just a single entry, though, so it should be relatively easy to
      // spot.
      if (count($this->value) && isset($this->value[0])) {
        $this->value = reset($this->value);
      }
      $this->value = array_keys(array_filter($this->value));
      if (!$this->value) {
        return FALSE;
      }
    }
    return $accepted;
  }

  /**
   * Add this filter to the query.
   */
  public function query() {
    if ($this->operator === 'empty') {
      $this->query
        ->condition($this->real_field, NULL, '=', $this->options['group']);
      return;
    }
    if ($this->operator === 'not empty') {
      $this->query
        ->condition($this->real_field, NULL, '<>', $this->options['group']);
      return;
    }

    // Extract the value.
    while (is_array($this->value) && count($this->value) == 1) {
      $this->value = reset($this->value);
    }

    // Determine operator and conjunction. The defaults are already right for
    // "all of".
    $operator = '=';
    $conjunction = 'AND';
    switch ($this->operator) {
      case '=':
        $conjunction = 'OR';
        break;
      case '<>':
        $operator = '<>';
        break;
    }

    // If the value is an empty array, we either want no filter at all (for
    // "is none of"), or want to find only items with no value for the field.
    if ($this->value === array()) {
      if ($operator != '<>') {
        $this->query
          ->condition($this->real_field, NULL, '=', $this->options['group']);
      }
      return;
    }
    if (is_scalar($this->value) && $this->value !== '') {
      $this->query
        ->condition($this->real_field, $this->value, $operator, $this->options['group']);
    }
    elseif ($this->value) {
      $filter = $this->query
        ->createFilter($conjunction);

      // $filter will be NULL if there were errors in the query.
      if ($filter) {
        foreach ($this->value as $v) {
          $filter
            ->condition($this->real_field, $v, $operator);
        }
        $this->query
          ->filter($filter, $this->options['group']);
      }
    }
  }

}

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
SearchApiViewsHandlerFilterOptions::$value_form_type protected property The type of form element used to display the options.
SearchApiViewsHandlerFilterOptions::$value_options protected property Stores the values which are available on the form.
SearchApiViewsHandlerFilterOptions::accept_exposed_input function Check to see if input from the exposed filters should change the behavior. Overrides views_handler_filter::accept_exposed_input
SearchApiViewsHandlerFilterOptions::admin_summary public function Provides a summary of this filter's value for the admin UI. Overrides SearchApiViewsHandlerFilter::admin_summary
SearchApiViewsHandlerFilterOptions::expose_form public function Add the "reduce" option to the exposed form. Overrides views_handler_filter::expose_form
SearchApiViewsHandlerFilterOptions::expose_options public function Set "reduce" option to FALSE by default. Overrides views_handler_filter::expose_options
SearchApiViewsHandlerFilterOptions::get_value_options protected function Fills the value_options property with all possible options. 1
SearchApiViewsHandlerFilterOptions::get_wrapper protected function Retrieves a wrapper for this filter's field.
SearchApiViewsHandlerFilterOptions::operator_options public function Provide a list of options for the operator form. Overrides SearchApiViewsHandlerFilter::operator_options
SearchApiViewsHandlerFilterOptions::option_definition public function Define "reduce" option. Overrides views_handler_filter::option_definition
SearchApiViewsHandlerFilterOptions::query public function Add this filter to the query. Overrides SearchApiViewsHandlerFilter::query 1
SearchApiViewsHandlerFilterOptions::reduce_value_options protected function Reduce the options according to the selection.
SearchApiViewsHandlerFilterOptions::value_form public function Provide a form for setting options. Overrides SearchApiViewsHandlerFilter::value_form
SearchApiViewsHandlerFilterOptions::value_submit public function Save set checkboxes. Overrides views_handler_filter::value_submit
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::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_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'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_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