class views_handler_argument_search
Argument that accepts query keys for search.
Hierarchy
- class \views_object
- class \views_handler
- class \views_handler_argument
- class \views_handler
Expanded class hierarchy of views_handler_argument_search
Related topics
2 string references to 'views_handler_argument_search'
- search_views_data in modules/
search.views.inc - Implements hook_views_data().
- search_views_plugins in modules/
search.views.inc - Implements hook_views_plugins().
File
- modules/
search/ views_handler_argument_search.inc, line 13 - Definition of views_handler_argument_search.
View source
class views_handler_argument_search extends views_handler_argument {
/**
* 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->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 argument to the query.
*/
function query($group_by = FALSE) {
$required = FALSE;
$this->query_parse_search_expression($this->argument);
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(0, 'FALSE');
}
}
else {
$search_index = $this->ensure_my_table();
$search_condition = db_and();
// Create a new join to relate the 'search_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(0, $search_condition);
$this->query->add_groupby("$search_index.sid");
$matches = $this->search_query->matches();
$placeholder = $this->placeholder();
$this->query->add_having_expression(0, "COUNT(*) >= $placeholder", array($placeholder => $matches));
}
}
}
Members
Name | Modifiers | Type | Description |
---|---|---|---|
views_handler:: |
public | property | The alias of the table of this handler which is used in the query. |
views_handler:: |
function | Take input from exposed handlers and assign to this handler, if necessary. | |
views_handler:: |
function | Check whether current user has access to this handler. | |
views_handler:: |
function | Provide text for the administrative summary | |
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 a handler can be exposed. | |
views_handler:: |
function | Transform a string by a certain method. | |
views_handler:: |
function | Ensure the main table for this handler is in the query. This is used a lot. | |
views_handler:: |
function | Render our chunk of the exposed handler form when selecting | |
views_handler:: |
function | Get information about the exposed form for the form renderer. | |
views_handler:: |
function | Submit the exposed handler form | |
views_handler:: |
function | Validate the exposed handler form | |
views_handler:: |
function | Form for exposed handler options. | |
views_handler:: |
function | Set new exposed option defaults when exposed setting is flipped on. | |
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:: |
function | Validate the options 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 | Shortcut to get a handler's raw field value. | |
views_handler:: |
function | Get the join object that should be used for this handler. | |
views_handler:: |
function | Provide a form for aggregation settings. | |
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 | If a handler has 'extra options' it will get a little settings widget and another form called extra_options. | |
views_handler:: |
function | Returns TRUE if the exposed filter works like a grouped filter. | |
views_handler:: |
function | Determine if this item is 'exposed', meaning it provides form elements to let users modify the view. | |
views_handler:: |
function | Define if the exposed input has to be submitted multiple times. This is TRUE when exposed filters grouped are using checkboxes as widgets. | |
views_handler:: |
function | Provides a unique placeholders for handlers. | |
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:: |
function | Called just prior to query(), this lets a handler set up any relationship it needs. | |
views_handler:: |
function | Shortcut to display the expose/hide button. | |
views_handler:: |
function | Shortcut to display the exposed options form. | |
views_handler:: |
function | If set to remember exposed input in the session, store it there. | |
views_handler:: |
function | Return a string representing this handler's name in the UI. | |
views_handler:: |
function | Provides the handler some groupby. | |
views_handler:: |
function | Validates the handler against the complete View. | |
views_handler_argument:: |
function |
Constructor Overrides views_object:: |
|
views_handler_argument:: |
function | Default action: access denied. | |
views_handler_argument:: |
function | Handle the default action, which means our argument wasn't present. | |
views_handler_argument:: |
function | Provide a list of default behaviors for this argument if the argument is not present. | |
views_handler_argument:: |
function | Provide a form for selecting the default argument when the default action is set to provide default argument. | |
views_handler_argument:: |
function | This just returns true. The view argument builder will know where to find the argument from. | |
views_handler_argument:: |
function | Default action: empty | |
views_handler_argument:: |
function | Default action: ignore. | |
views_handler_argument:: |
function | Default action: not found. | |
views_handler_argument:: |
function | Default action: summary. | |
views_handler_argument:: |
function | Provide a form for selecting further summary options when the default action is set to display one. | |
views_handler_argument:: |
function | ||
views_handler_argument:: |
function | Generic plugin export handler. | |
views_handler_argument:: |
function | Export handler for summary export. | |
views_handler_argument:: |
function | Export handler for validation export. | |
views_handler_argument:: |
function | Get a default argument, if available. | |
views_handler_argument:: |
function | Get the display or row plugin, if it exists. | |
views_handler_argument:: |
function | Return a description of how the argument would normally be sorted. | |
views_handler_argument:: |
function | Called by the view object to get the title. This may be set by a validator so we don't necessarily call through to title(). | |
views_handler_argument:: |
function | Get the value of this argument. | |
views_handler_argument:: |
function | Determine if the argument is set to provide a default argument. | |
views_handler_argument:: |
function |
init the handler with necessary data. Overrides views_handler:: |
|
views_handler_argument:: |
function | ||
views_handler_argument:: |
function |
Determine if the argument needs a style plugin. Overrides views_handler:: |
|
views_handler_argument:: |
function |
Build the options form. Overrides views_handler:: |
|
views_handler_argument:: |
function |
Perform any necessary changes to the form values prior to storage.
There is no need for this function to actually store the data. Overrides views_handler:: |
|
views_handler_argument:: |
function |
Validate the options form. Overrides views_handler:: |
|
views_handler_argument:: |
function |
Information about options for all kinds of purposes will be held here.
@code
'option_name' => array( Overrides views_handler:: |
|
views_handler_argument:: |
function | Process the summary arguments for display. | |
views_handler_argument:: |
function | Set the input for this argument | |
views_handler_argument:: |
function | Give an argument the opportunity to modify the breadcrumb, if it wants. This only gets called on displays where a breadcrumb is actually used. | |
views_handler_argument:: |
function | Provide the argument to use to link from the summary to the next level; this will be called once per row of a summary, and used as part of $view->get_url(). | |
views_handler_argument:: |
function | Some basic summary behavior that doesn't need to be repeated as much as code that goes into summary_query() | |
views_handler_argument:: |
function | Provides the name to use for the summary. By default this is just the name field. | |
views_handler_argument:: |
function | Add the name field, which is the field displayed in summary queries. This is often used when the argument is numeric. | |
views_handler_argument:: |
function | Build the info for the summary query. | |
views_handler_argument:: |
function | Sorts the summary based upon the user's selection. The base variant of this is usually adequte. | |
views_handler_argument:: |
function | Get the title this argument will assign the view, given the argument. | |
views_handler_argument:: |
function | Determine if the argument can generate a breadcrumb | |
views_handler_argument:: |
function | Validate that this argument works. By default, all arguments are valid. | |
views_handler_argument:: |
function | Called by the menu system to validate an argument. | |
views_handler_argument:: |
function | Provide a basic argument validation. | |
views_handler_argument:: |
function | How to act if validation failes | |
views_handler_argument_search:: |
function |
Add this argument to the query. Overrides views_handler_argument:: |
|
views_handler_argument_search:: |
function | Take sure that parseSearchExpression is runned and everything is set up for it. | |
views_object:: |
function | ||
views_object:: |
function | ||
views_object:: |
function | ||
views_object:: |
function | Always exports the option, regardless of the default value. | |
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 | Unpack a single option definition. | |
views_object:: |
function | Unpacks each handler to store translatable texts. | |
views_object:: |
function |