chado_views_handler_filter_string.inc

Go to the documentation of this file.

<?php

class chado_views_handler_filter_string extends views_handler_filter_string {

  function options_form(&$form, &$form_state) {
    $form['msg'] = array(
      '#type' => 'item',
      '#value' => '<b>If this filter applies to a table that is aggregated, additionally options may be ignored.</b>'
    );

    parent::options_form($form, $form_state);

    $form['agg'] = array(
      '#type' => 'fieldset',
      '#title' => 'Apply to fields that are aggregated'
    );

    $form['agg']['records_with'] = array(
      '#type' => 'checkbox',
      '#title' => t('Filter base table records'),
      '#description' => t('Filters %base_table to only those with the value in the aggregate array.', array('%base_table' => $this->view->base_table)),
      '#default_value' => (isset($this->options['agg']['records_with'])) ? $this->options['agg']['records_with'] : TRUE,
    );

    $form['agg']['aggregates_with'] = array(
      '#type' => 'checkbox',
      '#title' => t('Filter aggregates displayed'),
      '#description' => t('Filters the aggregates shown based on the value. Doesn\'t affect the number of %base_table records.', array('%base_table' => $this->view->base_table)),
      '#default_value' => (isset($this->options['agg']['aggregates_with'])) ? $this->options['agg']['aggregates_with'] : TRUE,
    );

  }

  function query() {

    // make optional
    // if it is not set or empty then don't restrict the query
    if (!$this->value) {
      return;
    }

    $this->ensure_my_table();

    $table = $this->query->get_table_info($this->table);
    if (preg_match('/aggregator/', $table['join']->definition['handler'])) {
      $this->aggregated = TRUE;
    }
    else {
      $this->aggregated = FALSE;
    }

    if (!$this->aggregated) {
      parent::query();
    }
    else {

      $this->ensure_my_table();
      $field = "$this->table_alias.$this->real_field";

      // Want to filter both the base table and the aggregated field
      if ($this->options['agg']['records_with'] && $this->options['agg']['aggregates_with']) {
        $where = "$field IS NOT NULL";
        $this->query->add_where($this->options['group'], $where);
        $table['join']->filter[] = $field . " " . $this->operator . " '" . $this->value . "'";
      }
      // Only base records with value in the aggregated field
      // This doesn't restrict the items in the aggregate field
      elseif ($this->options['agg']['records_with']) {
        if ($this->operator == '~') {
          // Currently postgresql doesn't support 'somevalue' ~ ANY(field) as a means of
          // selecting all records where the field matches somevalue. Instead what this notation means
          // is return TRUE if one of the values of field matches 'somevalue'
          // Instead add in a subclause
          $where = "array_to_string($field,'###') ~ '%s'";
          $this->query->add_where($this->options['group'], $where, $this->value);
        }
        else {
          $where = "'%s' " . $this->operator . " ANY($field)";
          $this->query->add_where($this->options['group'], $where, $this->value);
        }

      }
      // To restrict the items in the aggregate...
      // Tell the join handler about the filter
      // so it can be done in the join query
      if ($this->options['agg']['aggregates_with']) {
        $table['join']->filter[] = $field . " " . $this->operator . " '" . $this->value . "'";
      }
    }

  }

  function operators() {
    $operators = array(
      '=' => array(
        'title' => t('Is equal to'),
        'short' => t('='),
        'method' => 'op_equal',
        'values' => 1,
      ),
      '!=' => array(
        'title' => t('Is not equal to'),
        'short' => t('!='),
        'method' => 'op_equal',
        'values' => 1,
      ),
      '~' => array(
        'title' => t('Contains'),
        'short' => t('contains'),
        'method' => 'op_contains',
        'values' => 1,
      ),
    );

    return $operators;
  }

}