class views_handler_filter_boolean_operator

  1. 3.x handlers/views_handler_filter_boolean_operator.inc views_handler_filter_boolean_operator
  2. 2.x handlers/views_handler_filter_boolean_operator.inc views_handler_filter_boolean_operator

Simple filter to handle matching of boolean values

Definition items:

  • label: (REQUIRED) The label for the checkbox.
  • type: For basic 'true false' types, an item can specify the following:
    • true-false: True/false (this is the default)
    • yes-no: Yes/No
    • on-off: On/Off
  • accept null: Treat a NULL value as false.

Hierarchy

Expanded class hierarchy of views_handler_filter_boolean_operator

12 string references to 'views_handler_filter_boolean_operator'
comment_views_data in modules/comment.views.inc
hook_views_data in docs/docs.php
Describe table structure to Views.
locale_views_data in modules/locale.views.inc
Implementation of hook_views_data().
node_views_data in modules/node.views.inc
Implementation of hook_views_data()
poll_views_data in modules/poll.views.inc
Implementation of hook_views_data()

... See full list

File

handlers/views_handler_filter_boolean_operator.inc, line 13

View source
class views_handler_filter_boolean_operator extends views_handler_filter {
  // exposed filter options
  var $no_single = TRUE;
  // Don't display empty space where the operator would be.
  var $no_operator = TRUE;
  // Whether to accept NULL as a false value or not
  var $accept_null = FALSE;

  function construct() {
    $this->value_value = t('True');
    if (isset($this->definition['label'])) {
      $this->value_value = $this->definition['label'];
    }
    if (isset($this->definition['accept null'])) {
      $this->accept_null = (bool) $this->definition['accept null'];
    }
    else if (isset($this->definition['accept_null'])) {
      $this->accept_null = (bool) $this->definition['accept_null'];
    }
    $this->value_options = NULL;
    parent::construct();
  }

  /**
   * Return the possible options for this filter.
   *
   * Child classes should override this function to set the possible values
   * for the filter.  Since this is a boolean filter, the array should have
   * two possible keys: 1 for "True" and 0 for "False", although the labels
   * can be whatever makes sense for the filter.  These values are used for
   * configuring the filter, when the filter is exposed, and in the admin
   * summary of the filter.  Normally, this should be static data, but if it's
   * dynamic for some reason, child classes should use a guard to reduce
   * database hits as much as possible.
   */
  function get_value_options() {
    if (isset($this->definition['type'])) {
      if ($this->definition['type'] == 'yes-no') {
        $this->value_options = array(1 => t('Yes'), 0 => t('No'));
      }
      if ($this->definition['type'] == 'on-off') {
        $this->value_options = array(1 => t('On'), 0 => t('Off'));
      }
    }

    // Provide a fallback if the above didn't set anything.
    if (!isset($this->value_options)) {
      $this->value_options = array(1 => t('True'), 0 => t('False'));
    }
  }

  function option_definition() {
    $options = parent::option_definition();

    $options['value']['default'] = FALSE;

    return $options;
  }

  function operator_form(&$form, &$form_state) {
    $form['operator'] = array();
  }

  function value_form(&$form, &$form_state) {
    if (empty($this->value_options)) {
      // Initialize the array of possible values for this filter.
      $this->get_value_options();
    }
    if (!empty($form_state['exposed'])) {
      // Exposed filter: use a select box to save space.
      $filter_form_type = 'select';
    }
    else {
      // Configuring a filter: use radios for clarity.
      $filter_form_type = 'radios';
    }
    $form['value'] = array(
      '#type' => $filter_form_type,
      '#title' => $this->value_value,
      '#options' => $this->value_options,
      '#default_value' => $this->value,
    );
    if (!empty($this->options['exposed'])) {
      $identifier = $this->options['expose']['identifier'];
      if (!isset($form_state['input'][$identifier])) {
        $form_state['input'][$identifier] = $this->value;
      }
      // If we're configuring an exposed filter, add an <Any> option.
      if (empty($form_state['exposed']) || !empty($this->options['optional'])) {
        $any_label = variable_get('views_exposed_filter_any_label', 'old_any') == 'old_any' ? '<Any>' : t('- Any -');
        if ($form['value']['#type'] != 'select') {
          $any_label = check_plain($any_label);
        }
        $form['value']['#options'] = array('All' => $any_label) + $form['value']['#options'];
      }
    }
  }

  function value_validate(&$form, &$form_state) {
    if ($form_state['values']['options']['value'] == 'All' && empty($form_state['values']['options']['expose']['optional'])) {
      form_set_error('value', t('You must select a value unless this is an optional exposed filter.'));
    }
  }

  function admin_summary() {
    if (!empty($this->options['exposed'])) {
      return t('exposed');
    }
    if (empty($this->value_options)) {
      $this->get_value_options();
    }
    // Now that we have the valid options for this filter, just return the
    // human-readable label based on the current value.  The value_options
    // array is keyed with either 0 or 1, so if the current value is not
    // empty, use the label for 1, and if it's empty, use the label for 0.
    return $this->value_options[!empty($this->value)];
  }

  function expose_options() {
    parent::expose_options();
    $this->options['expose']['operator'] = '';
    $this->options['expose']['label'] = $this->value_value;
    $this->options['expose']['optional'] = FALSE;
  }

  function query() {
    $this->ensure_my_table();

    $where = "$this->table_alias.$this->real_field ";

    if (empty($this->value)) {
      $where .= '= 0';
      if ($this->accept_null) {
        $where = '(' . $where . " OR $this->table_alias.$this->real_field IS NULL)";
      }
    }
    else {
      if (!empty($this->definition['use equal'])) {
        $where .= '= 1';
      }
      else {
        $where .= '<> 0';
      }
    }
    $this->query->add_where($this->options['group'], $where);
  }
}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
views_handler::access function Check whether current user has access to this handler.
views_handler::broken function Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found.
views_handler::ensure_my_table function Ensure the main table for this handler is in the query. This is used a lot.
views_handler::exposed_submit function Submit the exposed filter form
views_handler::exposed_validate function Validate the exposed filter form
views_handler::extra_options function Provide defaults for the handler.
views_handler::extra_options_form function Provide a form for setting options.
views_handler::extra_options_submit 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 function Validate the options form.
views_handler::get_join function Get the join object that should be used for this handler.
views_handler::has_extra_options function If a handler has 'extra options' it will get a little settings widget and another form called extra_options.
views_handler::is_exposed function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
views_handler::needs_style_plugin function Determine if the argument needs a style plugin.
views_handler::pre_query function Run before the view is built.
views_handler::set_relationship function Called just prior to query(), this lets a handler set up any relationship it needs.
views_handler::ui_name function Return a string representing this handler's name in the UI.
views_handler::validate function Validates the handler against the complete View.
views_handler_filter::accept_exposed_input function Check to see if input from the exposed filters should change the behavior of this filter. Overrides views_handler::accept_exposed_input
views_handler_filter::can_expose function Determine if a filter can be exposed. Overrides views_handler::can_expose
views_handler_filter::exposed_form function Render our chunk of the exposed filter form when selecting Overrides views_handler::exposed_form
views_handler_filter::exposed_info function Tell the renderer about our exposed form. This only needs to be overridden for particularly complex forms. And maybe not even then. Overrides views_handler::exposed_info
views_handler_filter::exposed_translate function Make some translations to a form item to make it more suitable to exposing.
views_handler_filter::expose_form function Overridable form for exposed filter options.
views_handler_filter::expose_form_left function Handle the 'left' side fo the exposed options form.
views_handler_filter::expose_form_right function Handle the 'right' side fo the exposed options form.
views_handler_filter::expose_submit 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_filter::expose_validate function Validate the options form.
views_handler_filter::init function Provide some extra help to get the operator/value easier to use. Overrides views_handler::init
views_handler_filter::operator_options function Provide a list of options for the default operator form. Should be overridden by classes that don't override operator_form
views_handler_filter::operator_submit 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_filter::operator_validate function Validate the operator form.
views_handler_filter::options_form 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 views_handler::options_form
views_handler_filter::options_submit function Simple submit handler Overrides views_handler::options_submit
views_handler_filter::options_validate function Simple validate handler Overrides views_handler::options_validate
views_handler_filter::show_expose_button function Shortcut to display the expose/hide button.
views_handler_filter::show_expose_form function Shortcut to display the exposed options form.
views_handler_filter::show_operator_form function Shortcut to display the operator form.
views_handler_filter::show_value_form function Shortcut to display the value form.
views_handler_filter::store_exposed_input function If set to remember exposed input in the session, store it there. Overrides views_handler::store_exposed_input
views_handler_filter::value_submit 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_filter_boolean_operator::admin_summary function Display the filter on the administrative summary Overrides views_handler_filter::admin_summary
views_handler_filter_boolean_operator::construct function Views handlers use a special construct function so that we can more easily construct them with variable arguments. Overrides views_object::construct
views_handler_filter_boolean_operator::expose_options function Provide default options for exposed filters. Overrides views_handler_filter::expose_options
views_handler_filter_boolean_operator::get_value_options function Return the possible options for this filter.
views_handler_filter_boolean_operator::operator_form function Provide a form for setting the operator. Overrides views_handler_filter::operator_form
views_handler_filter_boolean_operator::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_handler_filter::option_definition
views_handler_filter_boolean_operator::query function Add this filter to the query. Overrides views_handler_filter::query
views_handler_filter_boolean_operator::value_form function Provide a form for setting options. Overrides views_handler_filter::value_form
views_handler_filter_boolean_operator::value_validate function Validate the options form. Overrides views_handler_filter::value_validate
views_object::destroy function
views_object::options function Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility.
views_object::set_default_options function Set default options. For backward compatibility, it sends the options array; this is a feature that will likely disappear at some point.
views_object::set_definition function Let the handler know what its full definition is.
views_object::unpack_options function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::_set_option_defaults function