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
2 string references to 'views_handler_filter_search'
- search_views_data in modules/
search.views.inc - Implementation of hook_views_data()
- search_views_handlers in modules/
search.views.inc - Implementation of hook_views_handlers() to register all of the basic handlers views uses.
File
- modules/
search/ views_handler_filter_search.inc, line 6
View source
class views_handler_filter_search extends views_handler_filter {
var $no_single = TRUE;
function option_definition() {
$options = parent::option_definition();
$options['operator']['default'] = 'optional';
return $options;
}
/**
* 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 exposed_form(&$form, &$form_state) {
if (isset($this->options['expose']['identifier'])) {
$key = $this->options['expose']['identifier'];
$form[$key] = array(
'#type' => 'textfield',
'#size' => 15,
'#default_value' => $this->value,
'#attributes' => array('title' => t('Enter the terms you wish to search for.')),
);
}
}
/**
* 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->search_query = search_parse_query($form_state['values'][$key]);
if ($this->search_query[2] == '') {
form_set_error($key, t('You must include at least one positive keyword with @count characters or more.', array('@count' => variable_get('minimum_word_size', 3))));
}
if ($this->search_query[6]) {
if ($this->search_query[6] == 'or') {
drupal_set_message(t('Search for either of the two terms with uppercase <strong>OR</strong>. For example, <strong>cats OR dogs</strong>.'));
}
}
}
}
/**
* 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() {
if (!isset($this->search_query) || empty($this->search_query[3])) {
if ($this->operator == 'required') {
$this->query->add_where($this->options['group'], 'FALSE');
}
}
else {
$search_index = $this->ensure_my_table();
$this->search_query[2] = str_replace('i.', "$search_index.", $this->search_query[2]);
// 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));
$this->query->add_where($this->options['group'], $this->search_query[2], $this->search_query[3]);
if (empty($this->query->relationships[$this->relationship])) {
$base_table = $this->query->base_table;
}
else {
$base_table = $this->query->relationships[$this->relationship]['base'];
}
$this->query->add_where($this->options['group'], "$search_index.type = '%s'", $base_table);
if (!$this->search_query[5]) {
$search_dataset = $this->query->add_table('search_dataset');
$this->search_query[0] = str_replace('d.', "$search_dataset.", $this->search_query[0]);
$this->query->add_where($this->options['group'], $this->search_query[0], $this->search_query[1]);
}
$this->query->add_groupby("$search_index.sid");
$this->query->add_having($this->options['group'], 'COUNT(*) >= %d', $this->search_query[4]);
}
}
}
Members
Name | Modifiers | Type | Description |
---|---|---|---|
views_handler:: |
function | Check whether current user has access to this handler. | |
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 | Ensure the main table for this handler is in the query. This is used a lot. | |
views_handler:: |
function | Submit the exposed filter form | |
views_handler:: |
function | Provide defaults for the handler. | |
views_handler:: |
function | Provide a form for setting options. | |
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 | Validate the options form. | |
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:: |
function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
views_handler:: |
function | Determine if the argument needs a style plugin. | |
views_handler:: |
function | Run before the view is built. | |
views_handler:: |
function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
views_handler:: |
function | Return a string representing this handler's name in the UI. | |
views_handler:: |
function | Validates the handler against the complete View. | |
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_filter:: |
function |
Display the filter on the administrative summary Overrides views_handler:: |
|
views_handler_filter:: |
function |
Determine if a filter can be exposed. Overrides views_handler:: |
|
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_filter:: |
function | Make some translations to a form item to make it more suitable to exposing. | |
views_handler_filter:: |
function | Overridable form for exposed filter options. | |
views_handler_filter:: |
function | Handle the 'left' side fo the exposed options form. | |
views_handler_filter:: |
function | Handle the 'right' side fo the exposed options form. | |
views_handler_filter:: |
function |
Provide default options for exposed filters. Overrides views_handler:: |
|
views_handler_filter:: |
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 | Validate the options form. | |
views_handler_filter:: |
function |
Provide some extra help to get the operator/value easier to use. Overrides views_handler:: |
|
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:: |
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 | Validate the operator form. | |
views_handler_filter:: |
function |
Provide the basic form which calls through to subforms.
If overridden, it is best to call through to the parent,
or to at least make sure all of the functions in this form
are called. Overrides views_handler:: |
|
views_handler_filter:: |
function |
Simple submit handler Overrides views_handler:: |
|
views_handler_filter:: |
function |
Simple validate handler Overrides views_handler:: |
|
views_handler_filter:: |
function | Shortcut to display the expose/hide button. | |
views_handler_filter:: |
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_filter:: |
function |
If set to remember exposed input in the session, store it there. Overrides views_handler:: |
|
views_handler_filter:: |
function | Provide a form for setting options. | |
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 | Validate the options form. | |
views_handler_filter_search:: |
function |
Provide a simple textfield for equality Overrides views_handler_filter:: |
|
views_handler_filter_search:: |
function |
Validate the options form. Overrides views_handler:: |
|
views_handler_filter_search:: |
function |
Provide simple equality operator Overrides views_handler_filter:: |
|
views_handler_filter_search:: |
function |
Information about options for all kinds of purposes will be held here. Overrides views_handler_filter:: |
|
views_handler_filter_search:: |
function |
Add this filter to the query. Overrides views_handler_filter:: |
|
views_object:: |
function | Views handlers use a special construct function so that we can more easily construct them with variable arguments. | |
views_object:: |
function | ||
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_object:: |
function | Let the handler know what its full definition is. | |
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 |