class views_handler_filter_equality

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

Simple filter to handle equal to / not equal to filters

Hierarchy

Expanded class hierarchy of views_handler_filter_equality

2 string references to 'views_handler_filter_equality'
search_views_data in modules/search.views.inc
Implementation of hook_views_data()
views_views_handlers in includes/handlers.inc
Implementation of hook_views_handlers() to register all of the basic handlers views uses.

File

handlers/views_handler_filter_equality.inc, line 5

View source
class views_handler_filter_equality extends views_handler_filter {
  // exposed filter options
  var $no_single = TRUE;

  /**
   * Provide simple equality operator
   */
  function operator_options() {
    return array(
      '=' => t('Is equal to'),
      '!=' => t('Is not equal to'),
    );
  }

  /**
   * Provide a simple textfield for equality
   */
  function value_form(&$form, &$form_state) {
    $form['value'] = array(
      '#type' => 'textfield',
      '#title' => t('Value'),
      '#size' => 30,
      '#default_value' => $this->value,
    );

    if (!empty($form_state['exposed'])) {
      $identifier = $this->options['expose']['identifier'];
      if (!isset($form_state['input'][$identifier])) {
        $form_state['input'][$identifier] = $this->value;
      }
    }
  }
}

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::admin_summary function Display the filter on the administrative summary Overrides views_handler::admin_summary
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_options function Provide default options for exposed filters. Overrides views_handler::expose_options
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_form function Provide a form for setting the operator.
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::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_object::option_definition
views_handler_filter::query function Add this filter to the query. Overrides views_handler::query
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::value_validate function Validate the options form.
views_handler_filter_equality::operator_options function Provide simple equality operator Overrides views_handler_filter::operator_options
views_handler_filter_equality::value_form function Provide a simple textfield for equality Overrides views_handler_filter::value_form
views_object::construct function Views handlers use a special construct function so that we can more easily construct them with variable arguments.
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