Do a query on the full-text search index for a word or words.
This function is normally only called by each module that supports the indexed search (and thus, implements hook_update_index()).
Results are retrieved in two logical passes. However, the two passes are joined together into a single query. And in the case of most simple queries the second pass is not even used.
The first pass selects a set of all possible matches, which has the benefit of also providing the exact result set for simple "AND" or "OR" searches.
The second portion of the query further refines this set by verifying advanced text conditions (such as negative or phrase matches).
The used query object has the tag 'search_$module' and can be further extended with hook_query_alter().
Hierarchy
- class SelectQueryExtender implements SelectQueryInterface
- class SearchQuery
Expanded class hierarchy of SearchQuery
File
- core/
modules/ search/ search.extender.inc, line 26 - Search query extender and helper functions.
Members
Name![]() |
Modifiers | Type | Description |
---|---|---|---|
SearchQuery:: |
protected | property | Conditions that are used for exact searches. |
SearchQuery:: |
protected | property | Indicates whether the first pass query has been executed. |
SearchQuery:: |
protected | property | Whether or not search expressions were ignored. |
SearchQuery:: |
protected | property | Positive and negative search keys. |
SearchQuery:: |
protected | property | Indicates how many matches for a search query are necessary. |
SearchQuery:: |
protected | property | Stores multipliers for score expressions. |
SearchQuery:: |
protected | property | Multiplier for the normalized search score. |
SearchQuery:: |
protected | property | Stores score expressions. |
SearchQuery:: |
protected | property | Stores arguments for score expressions. |
SearchQuery:: |
protected | property | The search query that is used for searching. |
SearchQuery:: |
protected | property | Indicates whether the first pass query requires complex conditions (LIKE). |
SearchQuery:: |
protected | property | Type of search (search module). |
SearchQuery:: |
protected | property | Array of search words. |
SearchQuery:: |
public | function | Adds a custom score expression to the search query. |
SearchQuery:: |
public | function |
Builds the default count query for SearchQuery. Overrides SelectQueryExtender:: |
SearchQuery:: |
public | function |
Executes the search. Overrides SelectQueryExtender:: |
SearchQuery:: |
public | function | Executes the first pass query. |
SearchQuery:: |
protected | function | Parses the search query into SQL conditions. |
SearchQuery:: |
protected | function | Helper function for parseQuery(). |
SearchQuery:: |
public | function | Sets up the search query expression. |
SearchQuery:: |
public | function | Applies a search option and removes it from the search query string. |
SelectQueryExtender:: |
protected | property | The connection object on which to run this query. |
SelectQueryExtender:: |
protected | property | The placeholder counter. |
SelectQueryExtender:: |
protected | property | The SelectQuery object we are extending/decorating. |
SelectQueryExtender:: |
protected | property | A unique identifier for this query object. |
SelectQueryExtender:: |
public | function |
Adds an expression to the list of "fields" to be selected. Overrides SelectQueryInterface:: |
SelectQueryExtender:: |
public | function |
Adds a field to the list to be SELECTed. Overrides SelectQueryInterface:: |
SelectQueryExtender:: |
public | function |
Join against another table in the database. Overrides SelectQueryInterface:: |
SelectQueryExtender:: |
public | function |
Adds additional metadata to the query. Overrides QueryAlterableInterface:: |
SelectQueryExtender:: |
public | function |
Adds a tag to a query. Overrides QueryAlterableInterface:: |
SelectQueryExtender:: |
public | function |
Gets a complete list of all values to insert into the prepared statement. Overrides QueryConditionInterface:: |
SelectQueryExtender:: |
public | function |
Compiles the saved conditions for later retrieval. Overrides QueryConditionInterface:: |
SelectQueryExtender:: |
public | function |
Check whether a condition has been previously compiled. Overrides QueryConditionInterface:: |
SelectQueryExtender:: |
public | function |
Helper function: builds the most common conditional clauses. Overrides QueryConditionInterface:: |
SelectQueryExtender:: |
public | function |
Gets a complete list of all conditions in this conditional clause. Overrides QueryConditionInterface:: |
SelectQueryExtender:: |
public | function |
Sets this query to be DISTINCT. Overrides SelectQueryInterface:: |
SelectQueryExtender:: |
public | function |
Sets a condition that the specified subquery returns values. Overrides QueryConditionInterface:: |
SelectQueryExtender:: |
public | function |
Enhance this object by wrapping it in an extender object. Overrides QueryExtendableInterface:: |
SelectQueryExtender:: |
public | function |
Add multiple fields from the same table to be selected. Overrides SelectQueryInterface:: |
SelectQueryExtender:: |
public | function |
Add FOR UPDATE to the query. Overrides SelectQueryInterface:: |
SelectQueryExtender:: |
public | function |
Compiles and returns an associative array of the arguments for this prepared statement. Overrides SelectQueryInterface:: |
SelectQueryExtender:: |
public | function |
Returns a reference to the expressions array for this query. Overrides SelectQueryInterface:: |
SelectQueryExtender:: |
public | function |
Returns a reference to the fields array for this query. Overrides SelectQueryInterface:: |
SelectQueryExtender:: |
public | function |
Returns a reference to the group-by array for this query. Overrides SelectQueryInterface:: |
SelectQueryExtender:: |
public | function |
Retrieves a given piece of metadata. Overrides QueryAlterableInterface:: |
SelectQueryExtender:: |
public | function |
Returns a reference to the order by array for this query. Overrides SelectQueryInterface:: |
SelectQueryExtender:: |
public | function |
Returns a reference to the tables array for this query. Overrides SelectQueryInterface:: |
SelectQueryExtender:: |
public | function |
Returns a reference to the union queries for this query. This include
queries for UNION, UNION ALL, and UNION DISTINCT. Overrides SelectQueryInterface:: |
SelectQueryExtender:: |
public | function |
Groups the result set by the specified field. Overrides SelectQueryInterface:: |
SelectQueryExtender:: |
public | function |
Determines if a given query has all specified tags. Overrides QueryAlterableInterface:: |
SelectQueryExtender:: |
public | function |
Determines if a given query has any specified tag. Overrides QueryAlterableInterface:: |
SelectQueryExtender:: |
public | function |
Determines if a given query has a given tag. Overrides QueryAlterableInterface:: |
SelectQueryExtender:: |
public | function | |
SelectQueryExtender:: |
public | function | |
SelectQueryExtender:: |
public | function | |
SelectQueryExtender:: |
public | function |
Helper function to build most common HAVING conditional clauses. Overrides SelectQueryInterface:: |
SelectQueryExtender:: |
public | function | |
SelectQueryExtender:: |
public | function |
Inner Join against another table in the database. Overrides SelectQueryInterface:: |
SelectQueryExtender:: |
function |
Sets a condition that the specified field be NOT NULL. Overrides QueryConditionInterface:: |
|
SelectQueryExtender:: |
function |
Sets a condition that the specified field be NULL. Overrides QueryConditionInterface:: |
|
SelectQueryExtender:: |
public | function |
Indicates if preExecute() has already been called on that object. Overrides SelectQueryInterface:: |
SelectQueryExtender:: |
public | function |
Default Join against another table in the database. Overrides SelectQueryInterface:: |
SelectQueryExtender:: |
public | function |
Left Outer Join against another table in the database. Overrides SelectQueryInterface:: |
SelectQueryExtender:: |
public | function |
Implements QueryPlaceholderInterface::nextPlaceholder(). Overrides QueryPlaceholderInterface:: |
SelectQueryExtender:: |
public | function |
Sets a condition that the specified subquery returns no values. Overrides QueryConditionInterface:: |
SelectQueryExtender:: |
public | function |
Orders the result set by a given field. Overrides SelectQueryInterface:: |
SelectQueryExtender:: |
public | function |
Orders the result set by a random value. Overrides SelectQueryInterface:: |
SelectQueryExtender:: |
public | function |
Generic preparation and validation for a SELECT query. Overrides SelectQueryInterface:: |
SelectQueryExtender:: |
public | function |
Restricts a query to a given range in the result set. Overrides SelectQueryInterface:: |
SelectQueryExtender:: |
public | function |
Right Outer Join against another table in the database. Overrides SelectQueryInterface:: |
SelectQueryExtender:: |
public | function |
Add another Select query to UNION to this one. Overrides SelectQueryInterface:: |
SelectQueryExtender:: |
public | function |
Implements QueryPlaceholderInterface::uniqueIdentifier(). Overrides QueryPlaceholderInterface:: |
SelectQueryExtender:: |
public | function |
Adds an arbitrary WHERE clause to the query. Overrides QueryConditionInterface:: |
SelectQueryExtender:: |
public | function | Magic override for undefined methods. |
SelectQueryExtender:: |
public | function |
Clone magic method. Overrides SelectQueryInterface:: |
SelectQueryExtender:: |
public | function | |
SelectQueryExtender:: |
public | function |