Added a default views entity filter

tripal/tripal.info

@@ -13,6 +13,7 @@ files[] = views_handlers/tripal_views_handler_filter_string_selectbox.inc
 files[] = views_handlers/tripal_views_handler_field_entity.inc
 files[] = views_handlers/tripal_views_handler_field_entity_status.inc
 files[] = views_handlers/tripal_views_handler_field_entity_default_formatter.inc
+files[] = views_handlers/tripal_views_handler_filter_entity_string.inc
 files[] = tripal_views_query.inc
 
 dependencies[] = views

tripal/tripal.views.inc

@@ -69,7 +69,7 @@ function tripal_entity_views_data() {
       // which handler to use. If not handler is specified then we use
       // a default string handler.
       $field_handler = 'tripal_views_handler_field_entity_default_formatter';
-      $filter_handler = 'views_handler_filter';
+      $filter_handler = 'tripal_views_handler_filter_entity_string';
       $sort_handler = 'views_handler_sort';
       $click_sortable = TRUE;
 

tripal/tripal_views_query.inc

@@ -45,6 +45,10 @@ class tripal_views_query extends views_plugin_query {
       $entity = tripal_load_entity('TripalEntity', array('id' => $entity_id));
       $entity = reset($entity);
 
+      // Get the filters
+      $filters = $view->filter;
+      $exclude = FALSE;
+      
       // Iterate through the fields that are added to the view and attach those
       // to the entity.  After attaching we can get the value and include
       // it in the output results.
@@ -53,14 +57,22 @@ class tripal_views_query extends views_plugin_query {
         field_attach_load($entity->type, array($entity->id => $entity), FIELD_LOAD_CURRENT,
             array('field_id' => $field['id']));
         $items = field_get_items('TripalEntity', $entity, $field_name);
-        //$row->$field_name = field_view_field('TripalEntity', $entity, $field_name);
         $value = $items[0]['value'];
+
+        // Filter the $value here
+        $filter = key_exists($field_name, $filters) ? $filters[$field_name] : NULL;
+        if ($filter && trim($filter->value)) {
+          $exclude = $filter->exclude($value);
+        }
+        
         $row->entity = $entity;
         $row->$field_name = $value;
       }
 
       // Add the row to the results list.
-      $view->result[] = $row;
+      if (!$exclude) {
+        $view->result[] = $row;
+      }
     }
 
     $view->total_rows = count($rows);

tripal/views_handlers/tripal_views_handler_filter_entity_string.inc

@@ -0,0 +1,272 @@
+<?php
+
+/**
+ * @file
+ * Definition of views_handler_filter_string.
+ */
+
+/**
+ * Basic textfield filter to handle string filtering commands
+ * including equality, like, not like, etc.
+ *
+ * @ingroup views_filter_handlers
+ */
+class tripal_views_handler_filter_entity_string extends views_handler_filter {
+  // exposed filter options
+  var $always_multiple = TRUE;
+
+  function option_definition() {
+    $options = parent::option_definition();
+
+    $options['expose']['contains']['required'] = array('default' => FALSE, 'bool' => TRUE);
+
+    return $options;
+  }
+
+  /**
+   * This kind of construct makes it relatively easy for a child class
+   * to add or remove functionality by overriding this function and
+   * adding/removing items from this array.
+   */
+  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,
+      ),
+      'contains' => array(
+        'title' => t('Contains'),
+        'short' => t('contains'),
+        'method' => 'op_contains',
+        'values' => 1,
+      ),
+      'starts' => array(
+        'title' => t('Starts with'),
+        'short' => t('begins'),
+        'method' => 'op_starts',
+        'values' => 1,
+      ),
+      'not_starts' => array(
+        'title' => t('Does not start with'),
+        'short' => t('not_begins'),
+        'method' => 'op_not_starts',
+        'values' => 1,
+      ),
+      'ends' => array(
+        'title' => t('Ends with'),
+        'short' => t('ends'),
+        'method' => 'op_ends',
+        'values' => 1,
+      ),
+      'not_ends' => array(
+        'title' => t('Does not end with'),
+        'short' => t('not_ends'),
+        'method' => 'op_not_ends',
+        'values' => 1,
+      ),
+      'not' => array(
+        'title' => t('Does not contain'),
+        'short' => t('!has'),
+        'method' => 'op_not',
+        'values' => 1,
+      ),
+    );
+    // if the definition allows for the empty operator, add it.
+    if (!empty($this->definition['allow empty'])) {
+      $operators += array(
+        'empty' => array(
+          'title' => t('Is empty (NULL)'),
+          'method' => 'op_empty',
+          'short' => t('empty'),
+          'values' => 0,
+        ),
+        'not empty' => array(
+          'title' => t('Is not empty (NOT NULL)'),
+          'method' => 'op_empty',
+          'short' => t('not empty'),
+          'values' => 0,
+        ),
+      );
+    }
+    // Add regexp support for MySQL.
+    if (Database::getConnection()->databaseType() == 'mysql') {
+      $operators += array(
+        'regular_expression' => array(
+          'title' => t('Regular expression'),
+          'short' => t('regex'),
+          'method' => 'op_regex',
+          'values' => 1,
+        ),
+      );
+    }
+
+    return $operators;
+  }
+
+  /**
+   * Build strings from the operators() for 'select' options
+   */
+  function operator_options($which = 'title') {
+    $options = array();
+    foreach ($this->operators() as $id => $info) {
+      $options[$id] = $info[$which];
+    }
+
+    return $options;
+  }
+
+  function admin_summary() {
+    if ($this->is_a_group()) {
+      return t('grouped');
+    }
+    if (!empty($this->options['exposed'])) {
+      return t('exposed');
+    }
+
+    $options = $this->operator_options('short');
+    $output = '';
+    if(!empty($options[$this->operator])) {
+      $output = check_plain($options[$this->operator]);
+    }
+    if (in_array($this->operator, $this->operator_values(1))) {
+      $output .= ' ' . check_plain($this->value);
+    }
+    return $output;
+  }
+
+  function operator_values($values = 1) {
+    $options = array();
+    foreach ($this->operators() as $id => $info) {
+      if (isset($info['values']) && $info['values'] == $values) {
+        $options[] = $id;
+      }
+    }
+
+    return $options;
+  }
+
+  /**
+   * Provide a simple textfield for equality
+   */
+  function value_form(&$form, &$form_state) {
+    // We have to make some choices when creating this as an exposed
+    // filter form. For example, if the operator is locked and thus
+    // not rendered, we can't render dependencies; instead we only
+    // render the form items we need.
+    $which = 'all';
+    if (!empty($form['operator'])) {
+      $source = ($form['operator']['#type'] == 'radios') ? 'radio:options[operator]' : 'edit-options-operator';
+    }
+    if (!empty($form_state['exposed'])) {
+      $identifier = $this->options['expose']['identifier'];
+
+      if (empty($this->options['expose']['use_operator']) || empty($this->options['expose']['operator_id'])) {
+        // exposed and locked.
+        $which = in_array($this->operator, $this->operator_values(1)) ? 'value' : 'none';
+      }
+      else {
+        $source = 'edit-' . drupal_html_id($this->options['expose']['operator_id']);
+      }
+    }
+
+    if ($which == 'all' || $which == 'value') {
+      $form['value'] = array(
+        '#type' => 'textfield',
+        '#title' => t('Value'),
+        '#size' => 30,
+        '#default_value' => $this->value,
+      );
+      if (!empty($form_state['exposed']) && !isset($form_state['input'][$identifier])) {
+        $form_state['input'][$identifier] = $this->value;
+      }
+
+      if ($which == 'all') {
+        $form['value'] += array(
+          '#dependency' => array($source => $this->operator_values(1)),
+        );
+      }
+    }
+
+    if (!isset($form['value'])) {
+      // Ensure there is something in the 'value'.
+      $form['value'] = array(
+        '#type' => 'value',
+        '#value' => NULL
+      );
+    }
+  }
+
+  function operator() {
+    return $this->operator == '=' ? 'LIKE' : 'NOT LIKE';
+  }
+
+  /**
+   * Add this filter to the query.
+   *
+   * Due to the nature of fapi, the value and the operator have an unintended
+   * level of indirection. You will find them in $this->operator
+   * and $this->value respectively.
+   */
+  function query() {
+  }
+
+  function op_equal($field) {
+  }
+
+  function op_contains($field) {
+  }
+
+  function op_starts($field) {
+  }
+
+  function op_not_starts($field) {
+  }
+
+  function op_ends($field) {
+  }
+
+  function op_not_ends($field) {
+  }
+
+  function op_not($field) {
+  }
+
+  function op_regex($field) {
+  }
+
+  function op_empty($field) {
+  }
+
+  function exclude ($value) {
+    $op = $this->operator;
+    $input = $this->value;
+    switch ($op) {
+      case '=':
+        return $value == $input ? FALSE : TRUE;
+      case '!=':
+        return $value != $input ? FALSE : TRUE;
+      case 'contains':
+        return preg_match("/$input/", $value) ? FALSE : TRUE;
+      case 'not':
+        return preg_match("/$input/", $value) ? TRUE : FALSE;
+      case 'starts':
+        return preg_match("/^$input/", $value) ? FALSE : TRUE;
+      case 'not_starts':
+        return preg_match("/^$input/", $value) ? TRUE : FALSE;
+      case 'ends':
+        return preg_match("/$input$/", $value) ? FALSE : TRUE;
+      case 'not_ends':
+        return preg_match("/$input$/", $value) ? TRUE : FALSE;
+        
+      return FALSE;
+    }
+  }
+}