class views_handler_filter_string in Views (for Drupal 7) 7.3
Same name and namespace in other branches
- 6.3 handlers/views_handler_filter_string.inc \views_handler_filter_string
- 6.2 handlers/views_handler_filter_string.inc \views_handler_filter_string
Basic textfield filter to handle string filtering commands including equality, like, not like, etc.
Hierarchy
- class \views_object
- class \views_handler
- class \views_handler_filter
- class \views_handler_filter_string
- class \views_handler_filter
- class \views_handler
Expanded class hierarchy of views_handler_filter_string
Related topics
12 string references to 'views_handler_filter_string'
- aggregator_views_data in modules/
aggregator.views.inc - Implements hook_views_data().
- comment_views_data in modules/
comment.views.inc - Implements hook_views_data().
- field_views_field_default_views_data in modules/
field.views.inc - Default views data implementation for a field.
- hook_views_data in ./
views.api.php - Describes data tables (or the equivalent) to Views.
- locale_views_data in modules/
locale.views.inc - Implements hook_views_data().
File
- handlers/
views_handler_filter_string.inc, line 14 - Definition of views_handler_filter_string.
View source
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) {
$placeholder = $this
->placeholder();
$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);
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
views_handler:: |
public | property | The type of the handler, for example filter/footer/field. | |
views_handler:: |
public | property | Where the $query object will reside:. | 1 |
views_handler:: |
public | property | The actual field in the database table, maybe different on other kind of query plugins/special handlers. | |
views_handler:: |
public | property | The relationship used for this field. | |
views_handler:: |
public | property | The alias of the table of this handler which is used in the query. | |
views_handler:: |
public | property |
The top object of a view. Overrides views_object:: |
|
views_handler:: |
public | function | Check whether current user has access to this handler. | 10 |
views_handler:: |
public | function | Determine if the handler is considered 'broken'. | 6 |
views_handler:: |
public | function | Transform a string by a certain method. | |
views_handler:: |
public | function | Ensure the main table for this handler is in the query. This is used a lot. | 8 |
views_handler:: |
public | function | Submit the exposed handler form. | |
views_handler:: |
public | function | Validate the exposed handler form. | 4 |
views_handler:: |
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:: |
public | function | Provide defaults for the handler. | |
views_handler:: |
public | function | Provide a form for setting options. | 1 |
views_handler:: |
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:: |
public | function | Validate the options form. | |
views_handler:: |
public | function | Shortcut to get a handler's raw field value. | |
views_handler:: |
public | function | Get the join object that should be used for this handler. | |
views_handler:: |
public | function | Provide a form for aggregation settings. | 1 |
views_handler:: |
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:: |
public | function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | 1 |
views_handler:: |
public | function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
views_handler:: |
public | function | Determine if the argument needs a style plugin. | 1 |
views_handler:: |
public | function | Provides a unique placeholders for handlers. | |
views_handler:: |
public | function | Run after the view is executed, before the result is cached. | 1 |
views_handler:: |
public | function | Run before the view is built. | 1 |
views_handler:: |
public | function | Sanitize the value for output. | |
views_handler:: |
public | function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
views_handler:: |
public | function | Shortcut to display the exposed options form. | |
views_handler:: |
public | function | Return a string representing this handler's name in the UI. | 9 |
views_handler:: |
public | function | Provides the handler some groupby. | 2 |
views_handler:: |
public | function | Validates the handler against the complete View. | 1 |
views_handler_filter:: |
public | property | Disable the possibility to allow a exposed input to be optional. | |
views_handler_filter:: |
public | property | Contains the information of the selected item in a gruped filter. | |
views_handler_filter:: |
public | property | Disable the possibility to use operators. | 2 |
views_handler_filter:: |
public | property | Contains the operator which is used on the query. | |
views_handler_filter:: |
public | property | Contains the actual value of the field. | |
views_handler_filter:: |
public | function |
Check to see if input from the exposed filters should change the behavior. Overrides views_handler:: |
2 |
views_handler_filter:: |
public | function | Build the form to let users create the group of exposed filters. | |
views_handler_filter:: |
public | function | Provide default options for exposed filters. | |
views_handler_filter:: |
public | function | Save new group items, re-enumerates and remove groups marked to delete. | |
views_handler_filter:: |
public | function | Validate the build group options form. | 1 |
views_handler_filter:: |
public | function | Determine if a filter can be converted into a group. | |
views_handler_filter:: |
public | function |
Determine if a filter can be exposed. Overrides views_handler:: |
5 |
views_handler_filter:: |
public | function | Can this filter be used in OR groups? | 1 |
views_handler_filter:: |
public | function | Transform the input from a grouped filter into a standard filter. | |
views_handler_filter:: |
public | function |
Render our chunk of the exposed filter form when selecting. Overrides views_handler:: |
|
views_handler_filter:: |
public | function |
Tell the renderer about our exposed form. Overrides views_handler:: |
|
views_handler_filter:: |
public | function | Make some translations to a form item to make it more suitable to exposing. | |
views_handler_filter:: |
public | function |
Options form subform for exposed filter options. Overrides views_handler:: |
2 |
views_handler_filter:: |
public | function |
Provide default options for exposed filters. Overrides views_handler:: |
2 |
views_handler_filter:: |
public | function |
Validate the options form. Overrides views_handler:: |
|
views_handler_filter:: |
public | function | Build a form with a group of operator | values to apply as a single filter. | |
views_handler_filter:: |
public | function | Options available for a grouped filter which uses checkboxes. | |
views_handler_filter:: |
public | function |
Provide some extra help to get the operator/value easier to use. Overrides views_handler:: |
2 |
views_handler_filter:: |
public | function |
Returns TRUE if the exposed filter works like a grouped filter. Overrides views_handler:: |
|
views_handler_filter:: |
public | function |
Indicate whether users can select multiple group items. Overrides views_handler:: |
|
views_handler_filter:: |
public | function | Options form subform for setting the operator. | 6 |
views_handler_filter:: |
public | function | Perform any necessary changes to the form values prior to storage. | |
views_handler_filter:: |
public | function | Validate the operator form. | |
views_handler_filter:: |
public | function |
Provide the basic form which calls through to subforms. Overrides views_handler:: |
4 |
views_handler_filter:: |
public | function |
Simple submit handler. Overrides views_handler:: |
|
views_handler_filter:: |
public | function |
Simple validate handler. Overrides views_handler:: |
1 |
views_handler_filter:: |
public | function | Sanitizes the HTML select element's options. | |
views_handler_filter:: |
public | function | Shortcut to display the build_group/hide button. | |
views_handler_filter:: |
public | function | Shortcut to display the exposed options form. | |
views_handler_filter:: |
public | function |
Shortcut to display the expose/hide button. Overrides views_handler:: |
|
views_handler_filter:: |
public | function | Shortcut to display the operator form. | |
views_handler_filter:: |
public | function | Shortcut to display the value form. | |
views_handler_filter:: |
public | function |
Store the exposed input for processing later. Overrides views_handler:: |
|
views_handler_filter:: |
public | function | If set to remember exposed input in the session, store it there. | |
views_handler_filter:: |
public | function | Perform any necessary changes to the form values prior to storage. | 1 |
views_handler_filter:: |
public | function | Validate the options form. | 3 |
views_handler_filter_string:: |
public | property |
Exposed filter options. Overrides views_handler_filter:: |
|
views_handler_filter_string:: |
public | function |
Display the filter on the administrative summary. Overrides views_handler_filter:: |
|
views_handler_filter_string:: |
public | function | ||
views_handler_filter_string:: |
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:: |
public | function |
Build strings from the operators() for 'select' options. Overrides views_handler_filter:: |
|
views_handler_filter_string:: |
public | function | ||
views_handler_filter_string:: |
public | function |
Information about options for all kinds of purposes will be held here. Overrides views_handler_filter:: |
1 |
views_handler_filter_string:: |
public | function | 1 | |
views_handler_filter_string:: |
public | function | 1 | |
views_handler_filter_string:: |
public | function | 1 | |
views_handler_filter_string:: |
public | function | 1 | |
views_handler_filter_string:: |
public | function | ||
views_handler_filter_string:: |
public | function | 1 | |
views_handler_filter_string:: |
public | function | 1 | |
views_handler_filter_string:: |
public | function | 1 | |
views_handler_filter_string:: |
public | function | 1 | |
views_handler_filter_string:: |
public | function | 1 | |
views_handler_filter_string:: |
public | function | ||
views_handler_filter_string:: |
public | function | 1 | |
views_handler_filter_string:: |
public | function | 1 | |
views_handler_filter_string:: |
public | function |
Add this filter to the query. Overrides views_handler_filter:: |
1 |
views_handler_filter_string:: |
public | function |
Provide a simple textfield for equality. Overrides views_handler_filter:: |
|
views_object:: |
public | property | Handler's definition. | |
views_object:: |
public | property | Except for displays, options for the object will be held here. | 1 |
views_object:: |
function | Collect this handler's option definition and alter them, ready for use. | ||
views_object:: |
public | function | Views handlers use a special construct function. | 4 |
views_object:: |
public | function | Destructor. | 2 |
views_object:: |
public | function | 1 | |
views_object:: |
public | function | ||
views_object:: |
public | function | Always exports the option, regardless of the default value. | |
views_object:: |
public | function | Set default options on this object. | 1 |
views_object:: |
public | function | Set default options. | |
views_object:: |
public | function | Let the handler know what its full definition is. | |
views_object:: |
public | function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
views_object:: |
public | function | Unpack a single option definition. | |
views_object:: |
public | function | Unpacks each handler to store translatable texts. | |
views_object:: |
public | function |