You are here

Home » API reference » Matrix field 7.2 » matrix_handler_filter.inc

class matrix_handler_filter in Matrix field 7.2

Same name and namespace in other branches
  1. 8.2 views/matrix_handler_filter.inc \matrix_handler_filter

Basic textfield filter to handle string filtering commands including equality, like, not like, etc.

Hierarchy

Expanded class hierarchy of matrix_handler_filter

1 string reference to 'matrix_handler_filter'
matrix_field_views_data_alter in views/matrix.views.inc
Implements hook_field_views_data_alter().

File

views/matrix_handler_filter.inc, line 8

View source 
class matrix_handler_filter extends views_handler_filter_string {
  function construct() {
    parent::construct();
    $this->value_title = t('Cell');
    $this->value_options = NULL;
  }
  function row_list() {
    $field = field_info_field($this->definition['field_name']);
    if ($field['type'] == 'matrix_text' && $field['settings']['spreadsheet_style'] == 1) {
      for ($i = 1; $i <= $field['settings']['rows_count']; $i++) {
        $output[$i] = $i;
      }
    }
    elseif ($field['type'] == 'matrix_custom') {
      $settings = unserialize($field['settings']['settings']);
      foreach ($settings['rows'] as $row_id => $row) {
        $output[$row_id] = t('@title (Row @i)', array(
          '@title' => $row['title'],
          '@i' => $row_id,
        ));
      }
    }
    else {
      for ($i = 1; $i <= $field['settings']['rows_count']; $i++) {
        $output[$i] = t('Row @i', array(
          '@i' => $i,
        ));
      }
    }
    array_unshift($output, t('None'));
    return $output;
  }
  function col_list() {
    $field = field_info_field($this->definition['field_name']);
    if ($field['type'] == 'matrix_text' && $field['settings']['spreadsheet_style'] == 1) {
      for ($i = 1; $i <= $field['settings']['cols_count']; $i++) {
        $output[$i] = matrix_make_letter($i);
      }
    }
    elseif ($field['type'] == 'matrix_custom') {
      $settings = unserialize($field['settings']['settings']);
      foreach ($settings['cols'] as $col_id => $col) {
        $output[$row_id] = t('@title (Column @i)', array(
          '@title' => $col['title'],
          '@i' => $col_id,
        ));
      }
    }
    else {
      for ($i = 1; $i <= $field['settings']['cols_count']; $i++) {
        $output[$i] = t('Column @i', array(
          '@i' => $i,
        ));
      }
    }
    array_unshift($output, t('None'));
    return $output;
  }
  function option_definition() {
    $options = parent::option_definition();
    $options['value']['col'] = 1;
    $options['value']['row'] = 1;
    return $options;
  }

  /**
   * Provide a simple textfield for equality
   */
  function value_form(&$form, &$form_state) {
    if (isset($this->options['value'])) {
      list($row_default, $col_default, $value_default) = explode('_____', $this->value);
    }

    // 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'])) {

        // exposed and locked.
        $which = in_array($this->operator, $this
          ->operator_values(1)) ? 'value' : 'none';
      }
      else {
        $source = 'edit-' . drupal_html_id($this->options['expose']['operator']);
      }
    }
    if ($which == 'all' || $which == 'value') {
      $form['value'] = array(
        '#type' => 'textfield',
        '#title' => t('Value'),
        '#size' => 30,
        '#default_value' => $value_default,
      );
      if (!empty($form_state['exposed']) && !isset($form_state['input'][$identifier])) {
        $form_state['input'][$identifier] = $this->value;
      }
      if ($which == 'all') {
        $form['value'] += array(
          '#process' => array(
            'ctools_dependent_process',
          ),
          '#dependency' => array(
            $source => $this
              ->operator_values(1),
          ),
          '#prefix' => '<div id="edit-options-value-wrapper">',
        );
        $form['row'] = array(
          '#type' => 'select',
          '#title' => t('Row'),
          '#options' => $this
            ->row_list(),
          '#default_value' => $row_default,
          '#process' => array(
            'ctools_dependent_process',
          ),
        );
        $form['col'] = array(
          '#type' => 'select',
          '#title' => t('Column'),
          '#options' => $this
            ->col_list(),
          '#default_value' => $col_default,
          '#process' => array(
            'ctools_dependent_process',
          ),
          '#suffix' => '</div>',
        );
      }
    }
    if (!isset($form['value'])) {

      // Ensure there is something in the 'value'.
      $form['value'] = array(
        '#type' => 'value',
        '#value' => NULL,
      );
    }
    if (!isset($form['row'])) {

      // Ensure there is something in the 'row'.
      $form['row'] = array(
        '#type' => 'value',
        '#value' => NULL,
      );
    }
    if (!isset($form['col'])) {

      // Ensure there is something in the 'value'.
      $form['col'] = array(
        '#type' => 'value',
        '#value' => NULL,
      );
    }
  }
  function value_submit($form, &$form_state) {

    // Views does not apper to want to save anything from this form other than 'value' so the row, col, and value will be concatinated into the value cell.
    $form_state['values']['options']['value'] = $form_state['values']['options']['row'] . '_____' . $form_state['values']['options']['col'] . '_____' . $form_state['values']['options']['value'];
  }
  function admin_summary() {
    if (!empty($this->options['exposed'])) {
      return t('exposed');
    }
    $options = $this
      ->operator_options('short');
    $op = check_plain($options[$this->operator]);
    $rows = $this
      ->row_list();
    $cols = $this
      ->col_list();
    if (isset($this->value)) {
      list($row, $col, $value) = explode('_____', $this->value);
      return t("Cell at row '%row', column '%col' %op %value", array(
        '%row' => $rows[$row],
        '%col' => $cols[$col],
        '%op' => $op,
        '%value' => $value,
      ));
    }
    return $output;
  }
  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() {
    $this
      ->ensure_my_table();
    $field = substr("{$this->table_alias}.{$this->real_field}", 0, -5);
    $info = $this
      ->operators();
    if (!empty($info[$this->operator]['method'])) {
      $this
        ->{$info[$this->operator]['method']}($field);
    }
  }
  function op_equal($field) {
    $operator = $this
      ->operator();
    list($row, $col, $value) = explode('_____', $this->value);
    $this->query
      ->add_where($this->options['group'], $field . 'value', $value, $operator);
    $this->query
      ->add_where($this->options['group'], $field . 'row', $row, '=');
    $this->query
      ->add_where($this->options['group'], $field . 'col', $col, '=');
  }
  function op_contains($field) {
    $placeholder = $this
      ->placeholder();
    list($row, $col, $value) = explode('_____', $this->value);
    $this->query
      ->add_where_expression($this->options['group'], $field . "value LIKE {$placeholder}", array(
      $placeholder => '%' . db_like($value) . '%',
    ));
    $this->query
      ->add_where($this->options['group'], $field . 'row', $row, '=');
    $this->query
      ->add_where($this->options['group'], $field . 'col', $col, '=');
  }
  function op_word($field) {
    list($row, $col, $value) = explode('_____', $this->value);
    $where = $this->operator == 'word' ? db_or() : db_and();
    preg_match_all('/ (-?)("[^"]+"|[^" ]+)/i', ' ' . $value, $matches, PREG_SET_ORDER);
    foreach ($matches as $match) {
      $phrase = false;

      // Strip off phrase quotes
      if ($match[2][0] == '"') {
        $match[2] = substr($match[2], 1, -1);
        $phrase = true;
      }
      $words = trim($match[2], ',?!();:-');
      $words = $phrase ? array(
        $words,
      ) : preg_split('/ /', $words, -1, PREG_SPLIT_NO_EMPTY);
      foreach ($words as $word) {
        $placeholder = $this
          ->placeholder();
        $where
          ->where($field . "value LIKE {$placeholder}", array(
          $placeholder => '%' . db_like(trim($word, " ,!?")) . '%',
        ));
      }
    }
    if (!$where) {
      return;
    }

    // previously this was a call_user_func_array but that's unnecessary
    // as views will unpack an array that is a single arg.
    $this->query
      ->add_where($this->options['group'], $where);
    $this->query
      ->add_where($this->options['group'], $field . 'row', $row, '=');
    $this->query
      ->add_where($this->options['group'], $field . 'col', $col, '=');
  }
  function op_starts($field) {
    $placeholder = $this
      ->placeholder();
    list($row, $col, $value) = explode('_____', $this->value);
    $this->query
      ->add_where_expression($this->options['group'], $field . "value LIKE {$placeholder}", array(
      $placeholder => db_like($value) . '%',
    ));
    $this->query
      ->add_where($this->options['group'], $field . 'row', $row, '=');
    $this->query
      ->add_where($this->options['group'], $field . 'col', $col, '=');
  }
  function op_not_starts($field) {
    $placeholder = $this
      ->placeholder();
    list($row, $col, $value) = explode('_____', $this->value);
    $this->query
      ->add_where($this->options['group'], $field . 'row', $row, '=');
    $this->query
      ->add_where($this->options['group'], $field . 'col', $col, '=');
    $this->query
      ->add_where_expression($this->options['group'], $field . "value NOT LIKE {$placeholder}", array(
      $placeholder => db_like($value) . '%',
    ));
  }
  function op_ends($field) {
    $placeholder = $this
      ->placeholder();
    list($row, $col, $value) = explode('_____', $this->value);
    $this->query
      ->add_where($this->options['group'], $field . 'row', $row, '=');
    $this->query
      ->add_where($this->options['group'], $field . 'col', $col, '=');
    $this->query
      ->add_where_expression($this->options['group'], $field . "value LIKE {$placeholder}", array(
      $placeholder => '%' . db_like($value),
    ));
  }
  function op_not_ends($field) {
    $placeholder = $this
      ->placeholder();
    list($row, $col, $value) = explode('_____', $this->value);
    $this->query
      ->add_where($this->options['group'], $field . 'row', $row, '=');
    $this->query
      ->add_where($this->options['group'], $field . 'col', $col, '=');
    $this->query
      ->add_where_expression($this->options['group'], $field . "value NOT LIKE {$placeholder}", array(
      $placeholder => '%' . db_like($value),
    ));
  }
  function op_not($field) {
    $placeholder = $this
      ->placeholder();
    list($row, $col, $value) = explode('_____', $this->value);
    $this->query
      ->add_where($this->options['group'], $field . 'row', $row, '=');
    $this->query
      ->add_where($this->options['group'], $field . 'col', $col, '=');
    $this->query
      ->add_where_expression($this->options['group'], $field . "value NOT LIKE {$placeholder}", array(
      $placeholder => '%' . db_like($value) . '%',
    ));
  }
  function op_shorter($field) {
    $placeholder = $this
      ->placeholder();
    list($row, $col, $value) = explode('_____', $this->value);
    $this->query
      ->add_where($this->options['group'], $field . 'row', $row, '=');
    $this->query
      ->add_where($this->options['group'], $field . 'col', $col, '=');
    $this->query
      ->add_where($this->options['group'], "LENGTH(" . $field . "value) < {$placeholder}", array(
      $placeholder => $value,
    ), 'formula');
  }
  function op_longer($field) {
    $placeholder = $this
      ->placeholder();
    list($row, $col, $value) = explode('_____', $this->value);
    $this->query
      ->add_where($this->options['group'], $field . 'row', $row, '=');
    $this->query
      ->add_where($this->options['group'], $field . 'col', $col, '=');
    $this->query
      ->add_where($this->options['group'], "LENGTH(" . $field . "value) > {$placeholder}", array(
      $placeholder => $value,
    ), 'formula');
  }
  function op_empty($field) {
    if ($this->operator == 'empty') {
      $operator = "=";
    }
    else {
      $operator = "<>";
    }
    list($row, $col, $value) = explode('_____', $this->value);
    $this->query
      ->add_where($this->options['group'], $field . 'row', $row, '=');
    $this->query
      ->add_where($this->options['group'], $field . 'col', $col, '=');
    $this->query
      ->add_where($this->options['group'], $field . 'value', NULL, $operator);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
matrix_handler_filter::admin_summary function Display the filter on the administrative summary. Overrides views_handler_filter_string::admin_summary
matrix_handler_filter::col_list function
matrix_handler_filter::construct function Views handlers use a special construct function. Overrides views_object::construct
matrix_handler_filter::operator function Overrides views_handler_filter_string::operator
matrix_handler_filter::option_definition function Information about options for all kinds of purposes will be held here. Overrides views_handler_filter_string::option_definition
matrix_handler_filter::op_contains function Overrides views_handler_filter_string::op_contains
matrix_handler_filter::op_empty function Overrides views_handler_filter_string::op_empty
matrix_handler_filter::op_ends function Overrides views_handler_filter_string::op_ends
matrix_handler_filter::op_equal function Overrides views_handler_filter_string::op_equal
matrix_handler_filter::op_longer function Overrides views_handler_filter_string::op_longer
matrix_handler_filter::op_not function Overrides views_handler_filter_string::op_not
matrix_handler_filter::op_not_ends function Overrides views_handler_filter_string::op_not_ends
matrix_handler_filter::op_not_starts function Overrides views_handler_filter_string::op_not_starts
matrix_handler_filter::op_shorter function Overrides views_handler_filter_string::op_shorter
matrix_handler_filter::op_starts function Overrides views_handler_filter_string::op_starts
matrix_handler_filter::op_word function Overrides views_handler_filter_string::op_word
matrix_handler_filter::query function Add this filter to the query. Overrides views_handler_filter_string::query
matrix_handler_filter::row_list function
matrix_handler_filter::value_form function Provide a simple textfield for equality Overrides views_handler_filter_string::value_form
matrix_handler_filter::value_submit function Perform any necessary changes to the form values prior to storage. Overrides views_handler_filter::value_submit
views_handler::$handler_type public property The type of the handler, for example filter/footer/field.
views_handler::$query public property Where the $query object will reside:. 1
views_handler::$real_field public property The actual field in the database table, maybe different on other kind of query plugins/special handlers.
views_handler::$relationship public property The relationship used for this field.
views_handler::$table_alias public property The alias of the table of this handler which is used in the query.
views_handler::$view public property The top object of a view. Overrides views_object::$view
views_handler::access public function Check whether current user has access to this handler. 10
views_handler::broken public function Determine if the handler is considered 'broken'. 6
views_handler::case_transform public function Transform a string by a certain method.
views_handler::ensure_my_table public function Ensure the main table for this handler is in the query. This is used a lot. 8
views_handler::exposed_submit public function Submit the exposed handler form.
views_handler::exposed_validate public function Validate the exposed handler form. 4
views_handler::expose_submit public 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 public function Provide defaults for the handler.
views_handler::extra_options_form public function Provide a form for setting options. 1
views_handler::extra_options_submit public 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 public function Validate the options form.
views_handler::get_field public function Shortcut to get a handler's raw field value.
views_handler::get_join public function Get the join object that should be used for this handler.
views_handler::groupby_form public function Provide a form for aggregation settings. 1
views_handler::groupby_form_submit public function Perform any necessary changes to the form values prior to storage. There is no need for this function to actually store the data. 1
views_handler::has_extra_options public function If a handler has 'extra options' it will get a little settings widget and another form called extra_options. 1
views_handler::is_exposed public function Determine if this item is 'exposed', meaning it provides form elements to let users modify the view.
views_handler::needs_style_plugin public function Determine if the argument needs a style plugin. 1
views_handler::placeholder public function Provides a unique placeholders for handlers.
views_handler::post_execute public function Run after the view is executed, before the result is cached. 1
views_handler::pre_query public function Run before the view is built. 1
views_handler::sanitize_value public function Sanitize the value for output.
views_handler::set_relationship public function Called just prior to query(), this lets a handler set up any relationship it needs.
views_handler::show_expose_form public function Shortcut to display the exposed options form.
views_handler::ui_name public function Return a string representing this handler's name in the UI. 9
views_handler::use_group_by public function Provides the handler some groupby. 2
views_handler::validate public function Validates the handler against the complete View. 1
views_handler_filter::$always_required public property Disable the possibility to allow a exposed input to be optional.
views_handler_filter::$group_info public property Contains the information of the selected item in a gruped filter.
views_handler_filter::$no_operator public property Disable the possibility to use operators. 2
views_handler_filter::$operator public property Contains the operator which is used on the query.
views_handler_filter::$value public property Contains the actual value of the field.
views_handler_filter::accept_exposed_input public function Check to see if input from the exposed filters should change the behavior. Overrides views_handler::accept_exposed_input 2
views_handler_filter::build_group_form public function Build the form to let users create the group of exposed filters.
views_handler_filter::build_group_options public function Provide default options for exposed filters.
views_handler_filter::build_group_submit public function Save new group items, re-enumerates and remove groups marked to delete.
views_handler_filter::build_group_validate public function Validate the build group options form. 1
views_handler_filter::can_build_group public function Determine if a filter can be converted into a group.
views_handler_filter::can_expose public function Determine if a filter can be exposed. Overrides views_handler::can_expose 5
views_handler_filter::can_group public function Can this filter be used in OR groups? 1
views_handler_filter::convert_exposed_input public function Transform the input from a grouped filter into a standard filter.
views_handler_filter::exposed_form public function Render our chunk of the exposed filter form when selecting. Overrides views_handler::exposed_form
views_handler_filter::exposed_info public function Tell the renderer about our exposed form. Overrides views_handler::exposed_info
views_handler_filter::exposed_translate public function Make some translations to a form item to make it more suitable to exposing.
views_handler_filter::expose_form public function Options form subform for exposed filter options. Overrides views_handler::expose_form 2
views_handler_filter::expose_options public function Provide default options for exposed filters. Overrides views_handler::expose_options 2
views_handler_filter::expose_validate public function Validate the options form. Overrides views_handler::expose_validate
views_handler_filter::group_form public function Build a form with a group of operator | values to apply as a single filter.
views_handler_filter::group_multiple_exposed_input public function Options available for a grouped filter which uses checkboxes.
views_handler_filter::init public function Provide some extra help to get the operator/value easier to use. Overrides views_handler::init 2
views_handler_filter::is_a_group public function Returns TRUE if the exposed filter works like a grouped filter. Overrides views_handler::is_a_group
views_handler_filter::multiple_exposed_input public function Indicate whether users can select multiple group items. Overrides views_handler::multiple_exposed_input
views_handler_filter::operator_form public function Options form subform for setting the operator. 6
views_handler_filter::operator_submit public function Perform any necessary changes to the form values prior to storage.
views_handler_filter::operator_validate public function Validate the operator form.
views_handler_filter::options_form public function Provide the basic form which calls through to subforms. Overrides views_handler::options_form 4
views_handler_filter::options_submit public function Simple submit handler. Overrides views_handler::options_submit
views_handler_filter::options_validate public function Simple validate handler. Overrides views_handler::options_validate 1
views_handler_filter::prepare_filter_select_options public function Sanitizes the HTML select element's options.
views_handler_filter::show_build_group_button public function Shortcut to display the build_group/hide button.
views_handler_filter::show_build_group_form public function Shortcut to display the exposed options form.
views_handler_filter::show_expose_button public function Shortcut to display the expose/hide button. Overrides views_handler::show_expose_button
views_handler_filter::show_operator_form public function Shortcut to display the operator form.
views_handler_filter::show_value_form public function Shortcut to display the value form.
views_handler_filter::store_exposed_input public function Store the exposed input for processing later. Overrides views_handler::store_exposed_input
views_handler_filter::store_group_input public function If set to remember exposed input in the session, store it there.
views_handler_filter::value_validate public function Validate the options form. 3
views_handler_filter_string::$always_multiple public property Exposed filter options. Overrides views_handler_filter::$always_multiple
views_handler_filter_string::operators public function 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.
views_handler_filter_string::operator_options public function Build strings from the operators() for 'select' options. Overrides views_handler_filter::operator_options
views_handler_filter_string::operator_values public function
views_handler_filter_string::op_not_regex public function 1
views_handler_filter_string::op_regex public function 1
views_object::$definition public property Handler's definition.
views_object::$options public property Except for displays, options for the object will be held here. 1
views_object::altered_option_definition function Collect this handler's option definition and alter them, ready for use.
views_object::destroy public function Destructor. 2
views_object::export_option public function 1
views_object::export_options public function
views_object::export_option_always public function Always exports the option, regardless of the default value.
views_object::options Deprecated public function Set default options on this object. 1
views_object::set_default_options public function Set default options.
views_object::set_definition public function Let the handler know what its full definition is.
views_object::unpack_options public function Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away.
views_object::unpack_translatable public function Unpack a single option definition.
views_object::unpack_translatables public function Unpacks each handler to store translatable texts.
views_object::_set_option_defaults public function