views_handler_filter_string.inc

<?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 views_handler_filter_string extends views_handler_filter {
    
    /**
     * Exposed filter options.
     */
    public $always_multiple = TRUE;
    
    /**
     * {@inheritdoc}
     */
    public 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.
     */
    public 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,
            ),
            'word' => array(
                'title' => t('Contains any word'),
                'short' => t('has word'),
                'method' => 'op_word',
                'values' => 1,
            ),
            'allwords' => array(
                'title' => t('Contains all words'),
                'short' => t('has all'),
                'method' => 'op_word',
                '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,
            ),
            'shorterthan' => array(
                'title' => t('Length is shorter than'),
                'short' => t('shorter than'),
                'method' => 'op_shorter',
                'values' => 1,
            ),
            'longerthan' => array(
                'title' => t('Length is longer than'),
                'short' => t('longer than'),
                'method' => 'op_longer',
                '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,
                ),
                'not_regular_expression' => array(
                    'title' => t('Not regular expression'),
                    'short' => t('not regex'),
                    'method' => 'op_not_regex',
                    'values' => 1,
                ),
            );
        }
        return $operators;
    }
    
    /**
     * Build strings from the operators() for 'select' options.
     */
    public function operator_options($which = 'title') {
        $options = array();
        foreach ($this->operators() as $id => $info) {
            $options[$id] = $info[$which];
        }
        return $options;
    }
    
    /**
     * {@inheritdoc}
     */
    public 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;
    }
    
    /**
     * {@inheritdoc}
     */
    public 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.
     */
    public 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,
            );
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public 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.
     */
    public function query() {
        $this->ensure_my_table();
        $field = "{$this->table_alias}.{$this->real_field}";
        $info = $this->operators();
        if (!empty($info[$this->operator]['method'])) {
            $this->{$info[$this->operator]['method']}($field);
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function op_equal($field) {
        $this->query
            ->add_where($this->options['group'], $field, $this->value, $this->operator());
    }
    
    /**
     * {@inheritdoc}
     */
    public function op_contains($field) {
        if (!empty($this->value)) {
            $this->query
                ->add_where($this->options['group'], $field, '%' . db_like($this->value) . '%', 'LIKE');
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public function op_word($field) {
        $where = $this->operator == 'word' ? db_or() : db_and();
        // Don't filter on empty strings.
        if (empty($this->value)) {
            return;
        }
        preg_match_all('/ (-?)("[^"]+"|[^" ]+)/i', ' ' . $this->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) {
                $where->condition($field, '%' . db_like(trim($word, " ,!?")) . '%', 'LIKE');
            }
        }
        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);
    }
    
    /**
     * {@inheritdoc}
     */
    public function op_starts($field) {
        $this->query
            ->add_where($this->options['group'], $field, db_like($this->value) . '%', 'LIKE');
    }
    
    /**
     * {@inheritdoc}
     */
    public function op_not_starts($field) {
        $this->query
            ->add_where($this->options['group'], $field, db_like($this->value) . '%', 'NOT LIKE');
    }
    
    /**
     * {@inheritdoc}
     */
    public function op_ends($field) {
        $this->query
            ->add_where($this->options['group'], $field, '%' . db_like($this->value), 'LIKE');
    }
    
    /**
     * {@inheritdoc}
     */
    public function op_not_ends($field) {
        $this->query
            ->add_where($this->options['group'], $field, '%' . db_like($this->value), 'NOT LIKE');
    }
    
    /**
     * {@inheritdoc}
     */
    public function op_not($field) {
        $this->query
            ->add_where($this->options['group'], $field, '%' . db_like($this->value) . '%', 'NOT LIKE');
    }
    
    /**
     * {@inheritdoc}
     */
    public function op_shorter($field) {
        $placeholder = $this->placeholder();
        $this->query
            ->add_where_expression($this->options['group'], "LENGTH({$field}) < {$placeholder}", array(
            $placeholder => $this->value,
        ));
    }
    
    /**
     * {@inheritdoc}
     */
    public function op_longer($field) {
        $placeholder = $this->placeholder();
        $this->query
            ->add_where_expression($this->options['group'], "LENGTH({$field}) > {$placeholder}", array(
            $placeholder => $this->value,
        ));
    }
    
    /**
     * {@inheritdoc}
     */
    public function op_regex($field) {
        $this->query
            ->add_where($this->options['group'], $field, $this->value, 'RLIKE');
    }
    
    /**
     * {@inheritdoc}
     */
    public function op_not_regex($field) {
        $this->query
            ->add_where($this->options['group'], $field, $this->value, 'NOT RLIKE');
    }
    
    /**
     * {@inheritdoc}
     */
    public function op_empty($field) {
        if ($this->operator == 'empty') {
            $operator = "IS NULL";
        }
        else {
            $operator = "IS NOT NULL";
        }
        $this->query
            ->add_where($this->options['group'], $field, NULL, $operator);
    }

}