class views_handler_filter_string_compare in Amazon Product Advertisement API 6
Same name and namespace in other branches
- 7.2 includes/views_handler_filter_string_compare.inc \views_handler_filter_string_compare
- 7 includes/views_handler_filter_string_compare.inc \views_handler_filter_string_compare
Basic textfield filter to handle string filtering commands including equality, like, not like, etc.
Hierarchy
- class \views_handler_filter_string_compare extends \views_handler_filter
Expanded class hierarchy of views_handler_filter_string_compare
2 string references to 'views_handler_filter_string_compare'
- amazon_views_handlers in includes/
amazon.views.inc - Implementation of hook_views_handlers()
- _amazon_make_simple_date_field in includes/
amazon.views.inc
File
- includes/
views_handler_filter_string_compare.inc, line 7
View source
class views_handler_filter_string_compare extends views_handler_filter {
// exposed filter options
var $no_single = TRUE;
function option_definition() {
$options = parent::option_definition();
$options['case'] = array(
'default' => 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,
),
'<' => array(
'title' => t('Is less than'),
'short' => t('!='),
'method' => 'op_equal',
'values' => 1,
),
'>' => array(
'title' => t('Is greater than'),
'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,
),
'ends' => array(
'title' => t('Ends with'),
'short' => t('ends'),
'method' => 'op_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 (NULL)'),
'method' => 'op_empty',
'short' => t('not empty'),
'values' => 0,
),
);
}
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 (!empty($this->options['exposed'])) {
return t('exposed');
}
$options = $this
->operator_options('short');
$output = check_plain($options[$this->operator]);
if (in_array($this->operator, $this
->operator_values(1))) {
$output .= ' ' . check_plain($this->value);
}
return $output;
}
function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
$form['case'] = array(
'#type' => 'checkbox',
'#title' => t('Case sensitive'),
'#default_value' => $this->options['case'],
'#description' => t('Case sensitive filters may be faster. MySQL might ignore case sensitivity.'),
);
}
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'])) {
// exposed and locked.
$which = in_array($this->operator, $this
->operator_values(1)) ? 'value' : 'none';
}
else {
$source = 'edit-' . form_clean_id($this->options['expose']['operator']);
}
}
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(
'#process' => array(
'views_process_dependency',
),
'#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 case_transform() {
return !empty($this->options['case']) ? '' : 'UPPER';
}
/**
* 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 = "{$this->table_alias}.{$this->real_field}";
$upper = $this
->case_transform();
$info = $this
->operators();
if (!empty($info[$this->operator]['method'])) {
$this
->{$info[$this->operator]['method']}($field, $upper);
}
}
function op_equal($field, $upper) {
// operator is either = or !=
$this->query
->add_where($this->options['group'], "{$upper}(%s) {$this->operator} {$upper}('%s')", $field, $this->value);
}
function op_contains($field, $upper) {
$this->query
->add_where($this->options['group'], "{$upper}(%s) LIKE {$upper}('%%%s%%')", $field, $this->value);
}
function op_word($field, $upper) {
$where = array();
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[] = "{$upper}(%s) LIKE {$upper}('%%%s%%')";
$values[] = $field;
$values[] = trim($word, " ,!?");
}
}
if (!$where) {
return;
}
if ($this->operator == 'word') {
$where = '(' . implode(' OR ', $where) . ')';
}
else {
$where = implode(' AND ', $where);
}
// 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, $values);
}
function op_starts($field, $upper) {
$this->query
->add_where($this->options['group'], "{$upper}(%s) LIKE {$upper}('%s%%')", $field, $this->value);
}
function op_ends($field, $upper) {
$this->query
->add_where($this->options['group'], "{$upper}(%s) LIKE {$upper}('%%%s')", $field, $this->value);
}
function op_not($field, $upper) {
$this->query
->add_where($this->options['group'], "{$upper}(%s) NOT LIKE {$upper}('%%%s%%')", $field, $this->value);
}
function op_empty($field) {
if ($this->operator == 'empty') {
$operator = "IS NULL";
}
else {
$operator = "IS NOT NULL";
}
$this->query
->add_where($this->options['group'], "{$field} {$operator}");
}
}