class views_handler_filter_fields_compare

Hierarchy

Expanded class hierarchy of views_handler_filter_fields_compare

1 string reference to 'views_handler_filter_fields_compare'

File

handlers/views_handler_filter_fields_compare.inc, line 14
Definition of views_handler_filter_fields_compare.

View source
class views_handler_filter_fields_compare extends views_handler_filter {

  function can_expose() {
    return FALSE;
  }

  /**
   * Overrides views_handler_filter#option_definition().
   */
  function option_definition() {
    $options = parent::option_definition();

    $options['left_field'] = $options['right_field'] = array('default' => '');

    return $options;
  }

  /**
   * Provide a list of all operators.
   */
  function fields_operator_options() {
    return array(
      '<' => t('Is less than'),
      '<=' => t('Is less than or equal to'),
      '=' => t('Is equal to'),
      '<>' => t('Is not equal to'),
      '>=' => t('Is greater than or equal to'),
      '>' => t('Is greater than')
    );
  }

  /**
   * Provide a list of available fields.
   */
  function field_options() {
    $options = array();

    $field_handlers = $this->view->display_handler->get_handlers('field');
    foreach ($field_handlers as $field => $handler) {
      if ($handler->table != 'views') {
        $options[$field] = $handler->ui_name();
      }
    }

    return $options;
  }

  /**
   * Overrides views_handler_filter#options_form().
   */
  function options_form(&$form, &$form_state) {
    parent::options_form($form, $form_state);

    $field_options = $this->field_options();

    $form['left_field'] = array(
      '#type' => 'select',
      '#title' => t('Left field'),
      '#default_value' => $this->options['left_field'],
      '#options' => $field_options,
      '#weight' => -3,
    );

    $form['operator'] = array(
      '#type' => 'select',
      '#title' => t('Operator'),
      '#default_value' => $this->options['operator'],
      '#options' => $this->fields_operator_options(),
      '#weight' => -2,
    );

    $form['right_field'] = array(
      '#type' => 'select',
      '#title' => t('Right field'),
      '#default_value' => $this->options['right_field'],
      '#options' => $field_options,
      '#weight' => -1,
    );

  }

  /**
   * Overrides views_handler_filter#query().
   *
   * Build extra condition from existing fields (from existing joins).
   */
  function query() {
    $left = $this->options['left_field'];
    $right = $this->options['right_field'];

    // Get all existing field handlers.
    $field_handlers = $this->view->display_handler->get_handlers('field');

    // Make sure the selected fields still exist.
    if (!isset($field_handlers[$left], $field_handlers[$right])) {
      return;
    }

    // Get the left table and field.
    $left_handler = $field_handlers[$left];
    $left_handler->set_relationship();
    $left_table_alias = $this->query->ensure_table($left_handler->table, $left_handler->relationship);

    // Get the left table and field.
    $right_handler = $field_handlers[$right];
    $right_handler->set_relationship();
    $right_table_alias = $this->query->ensure_table($right_handler->table, $right_handler->relationship);

    // Build piece of SQL.
    $snippet =
      $left_table_alias . '.' . $left_handler->real_field .
      ' ' . $this->options['operator'] . ' ' .
      $right_table_alias . '.' . $right_handler->real_field;

    $this->query->add_where_expression($this->options['group'], $snippet);
  }

  /**
   * Overrides views_handler_filter#admin_summary().
   */
  function admin_summary() {
    return check_plain(
    $this->options['left_field'] . ' ' .
      $this->options['operator'] . ' ' .
      $this->options['right_field']
      );
  }

}

Members

Contains filters are case sensitive
Namesort descending Modifiers Type Description
views_handler::$table_alias public property The alias of the table of this handler which is used in the query.
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::case_transform function Transform a string by a certain method.
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 handler form
views_handler::exposed_validate function Validate the exposed handler form
views_handler::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::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_field function Shortcut to get a handler's raw field value.
views_handler::get_join function Get the join object that should be used for this handler.
views_handler::groupby_form function Provide a form for aggregation settings.
views_handler::groupby_form_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::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::placeholder function Provides a unique placeholders for handlers.
views_handler::post_execute function Run after the view is executed, before the result is cached.
views_handler::pre_query function Run before the view is built.
views_handler::sanitize_value function Sanitize the value for output.
views_handler::set_relationship function Called just prior to query(), this lets a handler set up any relationship it needs.
views_handler::show_expose_form function Shortcut to display the exposed options form.
views_handler::ui_name function Return a string representing this handler's name in the UI.
views_handler::use_group_by function Provides the handler some groupby.
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::build_group_form function Build the form to let users create the group of exposed filters. This form is displayed when users click on button 'Build group'
views_handler_filter::build_group_options function Provide default options for exposed filters.
views_handler_filter::build_group_submit function Save new group items, re-enumerates and remove groups marked to delete.
views_handler_filter::build_group_validate function Validate the build group options form.
views_handler_filter::can_build_group function Determine if a filter can be converted into a group. Only exposed filters with operators available can be converted into groups.
views_handler_filter::can_group function Can this filter be used in OR groups?
views_handler_filter::convert_exposed_input function
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 Options form subform for exposed filter options. Overrides views_handler::expose_form
views_handler_filter::expose_options function Provide default options for exposed filters. Overrides views_handler::expose_options
views_handler_filter::expose_validate function Validate the options form. Overrides views_handler::expose_validate
views_handler_filter::group_form function Build a form containing a group of operator | values to apply as a single filter.
views_handler_filter::group_multiple_exposed_input function Returns the options available for a grouped filter that users checkboxes as widget, and therefore has to be applied several times, one per item selected.
views_handler_filter::init function Provide some extra help to get the operator/value easier to use. Overrides views_handler::init
views_handler_filter::is_a_group function Returns TRUE if the exposed filter works like a grouped filter. Overrides views_handler::is_a_group
views_handler_filter::multiple_exposed_input function Returns TRUE if users can select multiple groups items of a grouped exposed filter. Overrides views_handler::multiple_exposed_input
views_handler_filter::operator_form function Options form subform for setting the operator.
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_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::prepare_filter_select_options function Sanitizes the HTML select element's options.
views_handler_filter::show_build_group_button function Shortcut to display the build_group/hide button.
views_handler_filter::show_build_group_form function Shortcut to display the exposed options form.
views_handler_filter::show_expose_button function Shortcut to display the expose/hide button. Overrides views_handler::show_expose_button
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::store_group_input function If set to remember exposed input in the session, store it there. This function is similar to store_exposed_input but modified to work properly when the filter is a group.
views_handler_filter::value_form function Options form subform for setting options.
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_fields_compare::admin_summary function Overrides views_handler_filter#admin_summary(). Overrides views_handler_filter::admin_summary
views_handler_filter_fields_compare::can_expose function Determine if a filter can be exposed. Overrides views_handler_filter::can_expose
views_handler_filter_fields_compare::fields_operator_options function Provide a list of all operators.
views_handler_filter_fields_compare::field_options function Provide a list of available fields.
views_handler_filter_fields_compare::options_form function Overrides views_handler_filter#options_form(). Overrides views_handler_filter::options_form
views_handler_filter_fields_compare::option_definition function Overrides views_handler_filter#option_definition(). Overrides views_handler_filter::option_definition
views_handler_filter_fields_compare::query function Overrides views_handler_filter#query(). Overrides views_handler_filter::query
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::export_option function
views_object::export_options function
views_object::export_option_always function Always exports the option, regardless of the default value.
views_object::options Deprecated 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::unpack_translatable function Unpack a single option definition.
views_object::unpack_translatables function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults function