class views_handler_filter_search
- 3.x modules/search/views_handler_filter_search.inc views_handler_filter_search
- 2.x modules/search/views_handler_filter_search.inc views_handler_filter_search
Field handler to provide simple renderer that allows linking to a node.
Hierarchy
- class \views_object
- class \views_handler
- class \views_handler_filter
- class \views_handler_filter_search
- class \views_handler_filter
- class \views_handler
Expanded class hierarchy of views_handler_filter_search
Related topics
1 string reference to 'views_handler_filter_search'
- search_views_data in modules/
search.views.inc - Implements hook_views_data().
File
- modules/
search/ views_handler_filter_search.inc, line 13 - Contains a search filter handler.
View source
class views_handler_filter_search extends views_handler_filter {
var $always_multiple = TRUE;
/**
* Stores a viewsSearchQuery object to be able to use the search.module "api".
*
* @var viewsSearchQuery
*/
var $search_query = NULL;
/**
* Checks if the search query has been parsed.
*/
var $parsed = FALSE;
function option_definition() {
$options = parent::option_definition();
$options['operator']['default'] = 'optional';
$options['remove_score'] = array('default' => FALSE, 'bool' => TRUE);
return $options;
}
/**
* Overrides views_handler_filter::options_form().
*
* Add an option to remove search scores from the query.
*/
function options_form(&$form, &$form_state) {
parent::options_form($form, $form_state);
$form['remove_score'] = array(
'#type' => 'checkbox',
'#title' => t('Remove search score'),
'#description' => t('Check this box to remove the search score from the query. This can help reduce help reduce duplicate search results when using this filter.'),
'#default_value' => $this->options['remove_score'],
);
}
/**
* Provide simple equality operator
*/
function operator_form(&$form, &$form_state) {
$form['operator'] = array(
'#type' => 'radios',
'#title' => t('On empty input'),
'#default_value' => $this->operator,
'#options' => array(
'optional' => t('Show All'),
'required' => t('Show None'),
),
);
}
/**
* Provide a simple textfield for equality
*/
function value_form(&$form, &$form_state) {
$form['value'] = array(
'#type' => 'textfield',
'#size' => 15,
'#default_value' => $this->value,
'#attributes' => array('title' => t('Enter the terms you wish to search for.')),
'#title' => empty($form_state['exposed']) ? t('Value') : '',
);
}
/**
* Validate the options form.
*/
function exposed_validate(&$form, &$form_state) {
if (!isset($this->options['expose']['identifier'])) {
return;
}
$key = $this->options['expose']['identifier'];
if (!empty($form_state['values'][$key])) {
$this->query_parse_search_expression($form_state['values'][$key]);
if (count($this->search_query->words()) == 0) {
form_set_error($key, format_plural(variable_get('minimum_word_size', 3), 'You must include at least one positive keyword with 1 character or more.', 'You must include at least one positive keyword with @count characters or more.'));
}
}
}
/**
* Take sure that parseSearchExpression is runned and everything is set up for it.
*
* @param $input
* The search phrase which was input by the user.
*/
function query_parse_search_expression($input) {
if (!isset($this->search_query)) {
$this->parsed = TRUE;
$this->search_query = db_select('search_index', 'i', array('target' => 'slave'))->extend('viewsSearchQuery');
$this->search_query->searchExpression($input, $this->view->base_table);
$this->search_query->publicParseSearchExpression();
}
}
/**
* 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() {
// Since attachment views don't validate the exposed input, parse the search
// expression if required.
if (!$this->parsed) {
$this->query_parse_search_expression($this->value);
}
$required = FALSE;
if (!isset($this->search_query)) {
$required = TRUE;
}
else {
$words = $this->search_query->words();
if (empty($words)) {
$required = TRUE;
}
}
if ($required) {
if ($this->operator == 'required') {
$this->query->add_where($this->options['group'], 'FALSE');
}
}
else {
$search_index = $this->ensure_my_table();
$search_condition = db_and();
if (!$this->options['remove_score']) {
// Create a new join to relate the 'serach_total' table to our current 'search_index' table.
$join = new views_join;
$join->construct('search_total', $search_index, 'word', 'word');
$search_total = $this->query->add_relationship('search_total', $join, $search_index);
$this->search_score = $this->query->add_field('', "SUM($search_index.score * $search_total.count)", 'score', array('aggregate' => TRUE));
}
if (empty($this->query->relationships[$this->relationship])) {
$base_table = $this->query->base_table;
}
else {
$base_table = $this->query->relationships[$this->relationship]['base'];
}
$search_condition->condition("$search_index.type", $base_table);
if (!$this->search_query->simple()) {
$search_dataset = $this->query->add_table('search_dataset');
$conditions = $this->search_query->conditions();
$condition_conditions = &$conditions->conditions();
foreach ($condition_conditions as $key => &$condition) {
// Take sure we just look at real conditions.
if (is_numeric($key)) {
// Replace the conditions with the table alias of views.
$this->search_query->condition_replace_string('d.', "$search_dataset.", $condition);
}
}
$search_conditions = &$search_condition->conditions();
$search_conditions = array_merge($search_conditions, $condition_conditions);
}
else {
// Stores each condition, so and/or on the filter level will still work.
$or = db_or();
foreach ($words as $word) {
$or->condition("$search_index.word", $word);
}
$search_condition->condition($or);
}
$this->query->add_where($this->options['group'], $search_condition);
$this->query->add_groupby("$search_index.sid");
$matches = $this->search_query->matches();
$placeholder = $this->placeholder();
$this->query->add_having_expression($this->options['group'], "COUNT(*) >= $placeholder", array($placeholder => $matches));
}
// Set to NULL to prevent PDO exception when views object is cached.
$this->search_query = NULL;
}
}
Members
Name | Modifiers | Type | Description |
---|---|---|---|
views_handler_filter:: |
function | ||
views_object:: |
function | ||
views_object:: |
function | ||
views_object:: |
function | ||
views_object:: |
function | ||
views_handler_filter_search:: |
function |
Add this filter to the query. Overrides views_handler_filter:: |
|
views_object:: |
function | Always exports the option, regardless of the default value. | |
views_handler_filter:: |
function | Build a form containing a group of operator | values to apply as a single filter. | |
views_handler_filter:: |
function | Build the form to let users create the group of exposed filters. This form is displayed when users click on button 'Build group' | |
views_handler:: |
function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
views_handler_filter:: |
function | Can this filter be used in OR groups? | |
views_handler_filter:: |
function |
Check to see if input from the exposed filters should change
the behavior of this filter. Overrides views_handler:: |
|
views_handler:: |
function | Check whether current user has access to this handler. | |
views_handler_filter:: |
function | Determine if a filter can be converted into a group. Only exposed filters with operators available can be converted into groups. | |
views_handler_filter:: |
function |
Determine if a filter can be exposed. Overrides views_handler:: |
|
views_handler:: |
function | Determine if the argument needs a style plugin. | |
views_handler:: |
function | Determine if the handler is considered 'broken', meaning it's a a placeholder used when a handler can't be found. | |
views_handler:: |
function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
views_handler_filter:: |
function |
Display the filter on the administrative summary Overrides views_handler:: |
|
views_handler:: |
function | Ensure the main table for this handler is in the query. This is used a lot. | |
views_handler:: |
function | Get the join object that should be used for this handler. | |
views_handler:: |
function | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | |
views_handler_filter:: |
function | If set to remember exposed input in the session, store it there. This function is similar to store_exposed_input but modified to work properly when the filter is a group. | |
views_handler_filter:: |
function |
If set to remember exposed input in the session, store it there. Overrides views_handler:: |
|
views_handler_filter_search:: |
function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides views_handler_filter:: |
|
views_object:: |
function | Let the handler know what its full definition is. | |
views_handler_filter:: |
function | Make some translations to a form item to make it more suitable to exposing. | |
views_handler_filter:: |
function |
Options form subform for exposed filter options. Overrides views_handler:: |
|
views_handler_filter_search:: |
function |
Overrides views_handler_filter::options_form(). Overrides views_handler_filter:: |
|
views_handler:: |
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_filter:: |
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_filter:: |
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:: |
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:: |
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:: |
function | Provide a form for aggregation settings. | |
views_handler:: |
function | Provide a form for setting options. | |
views_handler_filter:: |
function | Provide a list of options for the default operator form. Should be overridden by classes that don't override operator_form | |
views_handler_filter_search:: |
function |
Provide a simple textfield for equality Overrides views_handler_filter:: |
|
views_handler_filter:: |
function |
Provide default options for exposed filters. Overrides views_handler:: |
|
views_handler_filter:: |
function | Provide default options for exposed filters. | |
views_handler:: |
function | Provide defaults for the handler. | |
views_handler_filter_search:: |
function |
Provide simple equality operator Overrides views_handler_filter:: |
|
views_handler_filter:: |
function |
Provide some extra help to get the operator/value easier to use. Overrides views_handler:: |
|
views_handler:: |
function | Provides a unique placeholders for handlers. | |
views_handler:: |
function | Provides the handler some groupby. | |
views_handler_filter:: |
function |
Render our chunk of the exposed filter form when selecting Overrides views_handler:: |
|
views_handler:: |
function | Return a string representing this handler's name in the UI. | |
views_handler_filter:: |
function | Returns the options available for a grouped filter that users checkboxes as widget, and therefore has to be applied several times, one per item selected. | |
views_handler_filter:: |
function |
Returns TRUE if the exposed filter works like a grouped filter. Overrides views_handler:: |
|
views_handler_filter:: |
function |
Returns TRUE if users can select multiple groups items of a
grouped exposed filter. Overrides views_handler:: |
|
views_handler:: |
function | Run after the view is executed, before the result is cached. | |
views_handler:: |
function | Run before the view is built. | |
views_handler:: |
function | Sanitize the value for output. | |
views_handler_filter:: |
function | Sanitizes the HTML select element's options. | |
views_handler_filter:: |
function | Save new group items, re-enumerates and remove groups marked to delete. | |
views_object:: |
function | Set default options on this object. Called by the constructor in a complex chain to deal with backward compatibility. | |
views_object:: |
function | Set default options. For backward compatibility, it sends the options array; this is a feature that will likely disappear at some point. | |
views_handler_filter:: |
function | Shortcut to display the build_group/hide button. | |
views_handler_filter:: |
function |
Shortcut to display the expose/hide button. Overrides views_handler:: |
|
views_handler_filter:: |
function | Shortcut to display the exposed options form. | |
views_handler:: |
function | Shortcut to display the exposed options form. | |
views_handler_filter:: |
function | Shortcut to display the operator form. | |
views_handler_filter:: |
function | Shortcut to display the value form. | |
views_handler:: |
function | Shortcut to get a handler's raw field value. | |
views_handler_filter:: |
function |
Simple submit handler Overrides views_handler:: |
|
views_handler_filter:: |
function |
Simple validate handler Overrides views_handler:: |
|
views_handler:: |
function | Submit the exposed handler form | |
views_handler_filter_search:: |
function | Take sure that parseSearchExpression is runned and everything is set up for it. | |
views_handler_filter:: |
function |
Tell the renderer about our exposed form. This only needs to be
overridden for particularly complex forms. And maybe not even then. Overrides views_handler:: |
|
views_handler:: |
public | property | The alias of the table of this handler which is used in the query. |
views_handler:: |
function | Transform a string by a certain method. | |
views_object:: |
function | Unpack a single option definition. | |
views_object:: |
function | Unpack options over our existing defaults, drilling down into arrays so that defaults don't get totally blown away. | |
views_object:: |
function | Unpacks each handler to store translatable texts. | |
views_handler_filter:: |
function | Validate the build group options form. | |
views_handler_filter:: |
function | Validate the operator form. | |
views_handler_filter_search:: |
function |
Validate the options form. Overrides views_handler:: |
|
views_handler_filter:: |
function | Validate the options form. | |
views_handler_filter:: |
function |
Validate the options form. Overrides views_handler:: |
|
views_handler:: |
function | Validate the options form. | |
views_handler:: |
function | Validates the handler against the complete View. | |
views_object:: |
function | Views handlers use a special construct function so that we can more easily construct them with variable arguments. |