class ViewsSearchQuery in Drupal 10
Same name in this branch
- 10 core/modules/search/src/ViewsSearchQuery.php \Drupal\search\ViewsSearchQuery
- 10 core/tests/fixtures/database_drivers/module/corefake/src/Driver/Database/corefakeWithAllCustomClasses/ViewsSearchQuery.php \Drupal\corefake\Driver\Database\corefakeWithAllCustomClasses\ViewsSearchQuery
Same name and namespace in other branches
- 8 core/modules/search/src/ViewsSearchQuery.php \Drupal\search\ViewsSearchQuery
- 9 core/modules/search/src/ViewsSearchQuery.php \Drupal\search\ViewsSearchQuery
Extends the core SearchQuery to be able to gets its protected values.
Hierarchy
- class \Drupal\Core\Database\Query\SelectExtender implements SelectInterface
- class \Drupal\search\SearchQuery
- class \Drupal\search\ViewsSearchQuery
- class \Drupal\search\SearchQuery
Expanded class hierarchy of ViewsSearchQuery
1 file declares its use of ViewsSearchQuery
- ViewsSearchQuery.php in core/
tests/ fixtures/ database_drivers/ module/ corefake/ src/ Driver/ Database/ corefakeWithAllCustomClasses/ ViewsSearchQuery.php
File
- core/
modules/ search/ src/ ViewsSearchQuery.php, line 10
Namespace
Drupal\searchView source
class ViewsSearchQuery extends SearchQuery {
/**
* Returns the conditions property.
*
* @return array
* The query conditions.
*/
public function &conditions() {
return $this->conditions;
}
/**
* Returns the words property.
*
* @return array
* The positive search keywords.
*/
public function words() {
return $this->words;
}
/**
* Returns the simple property.
*
* @return bool
* TRUE if it is a simple query, and FALSE if it is complicated (phrases
* or LIKE).
*/
public function simple() {
return $this->simple;
}
/**
* Returns the matches property.
*
* @return int
* The number of matches needed.
*/
public function matches() {
return $this->matches;
}
/**
* Executes and returns the protected parseSearchExpression method.
*/
public function publicParseSearchExpression() {
return $this
->parseSearchExpression();
}
/**
* Replaces the original condition with a custom one from views recursively.
*
* @param string $search
* The searched value.
* @param string $replace
* The value which replaces the search value.
* @param array $condition
* The query conditions array in which the string is replaced. This is an
* item from a \Drupal\Core\Database\Query\Condition::conditions array,
* which must have a 'field' element.
*/
public function conditionReplaceString($search, $replace, &$condition) {
if ($condition['field'] instanceof ConditionInterface) {
$conditions =& $condition['field']
->conditions();
foreach ($conditions as $key => &$subcondition) {
if (is_numeric($key)) {
// As conditions can be nested, the function has to be called
// recursively.
$this
->conditionReplaceString($search, $replace, $subcondition);
}
}
}
else {
$condition['field'] = str_replace($search, $replace, $condition['field']);
}
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
SearchQuery:: |
protected | property | Conditions that are used for exact searches. | |
SearchQuery:: |
protected | property | Indicates whether the preparation step has been executed. | |
SearchQuery:: |
protected | property | Parsed-out positive and negative search keys. | |
SearchQuery:: |
protected | property | Indicates how many matches for a search query are necessary. | |
SearchQuery:: |
protected | property | Multipliers for score expressions. | |
SearchQuery:: |
protected | property | Multiplier to normalize the keyword score. | |
SearchQuery:: |
protected | property | The number of 'i.relevance' occurrences in score expressions. | |
SearchQuery:: |
protected | property | The word score expressions. | |
SearchQuery:: |
protected | property | Arguments for the score expressions. | |
SearchQuery:: |
protected | property | The keywords and advanced search options that are entered by the user. | |
SearchQuery:: |
protected | property | Indicates whether the query conditions are simple or complex (LIKE). | |
SearchQuery:: |
protected | property | A bitmap of status conditions, described in getStatus(). | |
SearchQuery:: |
protected | property | The type of search (search type). | |
SearchQuery:: |
protected | property | Array of positive 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 SelectExtender:: |
|
SearchQuery:: |
public | function |
Executes the search. Overrides SelectExtender:: |
|
SearchQuery:: |
constant | Indicates that part of the search expression was ignored. | ||
SearchQuery:: |
public | function | Returns the query status bitmap. | |
SearchQuery:: |
constant | Indicates that lower-case "or" was in the search expression. | ||
SearchQuery:: |
constant | Indicates that no positive keyword matches were found. | ||
SearchQuery:: |
constant | Indicates no positive keywords were in the search expression. | ||
SearchQuery:: |
protected | function | Parses the search query into SQL conditions. | |
SearchQuery:: |
protected | function | Parses a word or phrase for parseQuery(). | |
SearchQuery:: |
public | function |
Generic preparation and validation for a SELECT query. Overrides SelectExtender:: |
|
SearchQuery:: |
public | function | Prepares the query and calculates the normalization factor. | |
SearchQuery:: |
public | function | Sets the search query expression. | |
SelectExtender:: |
protected | property | The connection object on which to run this query. | |
SelectExtender:: |
protected | property | The placeholder counter. | |
SelectExtender:: |
protected | property | The Select query object we are extending/decorating. | |
SelectExtender:: |
protected | property | A unique identifier for this query object. | |
SelectExtender:: |
public | function |
Adds an expression to the list of "fields" to be SELECTed. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Adds a field to the list to be SELECTed. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Join against another table in the database. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Adds additional metadata to the query. Overrides AlterableInterface:: |
|
SelectExtender:: |
public | function |
Adds a tag to a query. Overrides AlterableInterface:: |
|
SelectExtender:: |
public | function |
Sets a condition that is always false. Overrides ConditionInterface:: |
|
SelectExtender:: |
public | function |
Creates a new group of conditions ANDed together. Overrides ConditionInterface:: |
|
SelectExtender:: |
public | function |
Gets a complete list of all values to insert into the prepared statement. Overrides ConditionInterface:: |
|
SelectExtender:: |
public | function |
Compiles the saved conditions for later retrieval. Overrides ConditionInterface:: |
|
SelectExtender:: |
public | function |
Check whether a condition has been previously compiled. Overrides ConditionInterface:: |
|
SelectExtender:: |
public | function |
Helper function: builds the most common conditional clauses. Overrides ConditionInterface:: |
|
SelectExtender:: |
public | function |
Creates an object holding a group of conditions. Overrides ConditionInterface:: |
|
SelectExtender:: |
public | function |
Sets this query to be DISTINCT. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Escapes a field name string. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Escapes characters that work as wildcard characters in a LIKE pattern. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Sets a condition that the specified subquery returns values. Overrides ConditionInterface:: |
|
SelectExtender:: |
public | function |
Enhance this object by wrapping it in an extender object. Overrides ExtendableInterface:: |
|
SelectExtender:: |
public | function |
Add multiple fields from the same table to be SELECTed. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Add FOR UPDATE to the query. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Compiles and returns an associative array of the arguments for this prepared statement. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Returns a reference to the expressions array for this query. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Returns a reference to the fields array for this query. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Returns a reference to the group-by array for this query. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Retrieves a given piece of metadata. Overrides AlterableInterface:: |
|
SelectExtender:: |
public | function |
Returns a reference to the order by array for this query. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Returns a reference to the tables array for this query. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Returns a reference to the union queries for this query. This include
queries for UNION, UNION ALL, and UNION DISTINCT. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Groups the result set by the specified field. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Determines if a given query has all specified tags. Overrides AlterableInterface:: |
|
SelectExtender:: |
public | function |
Determines if a given query has any specified tag. Overrides AlterableInterface:: |
|
SelectExtender:: |
public | function |
Determines if a given query has a given tag. Overrides AlterableInterface:: |
|
SelectExtender:: |
public | function |
Adds an arbitrary HAVING clause to the query. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Gets a list of all values to insert into the HAVING clause. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Compiles the HAVING clause for later retrieval. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Helper function to build most common HAVING conditional clauses. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Gets a list of all conditions in the HAVING clause. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Sets a HAVING condition that the specified subquery returns values. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Sets a condition in the HAVING clause that the specified field be NOT NULL. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Sets a condition in the HAVING clause that the specified field be NULL. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Sets a HAVING condition that the specified subquery returns no values. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Inner Join against another table in the database. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Sets a condition that the specified field be NOT NULL. Overrides ConditionInterface:: |
|
SelectExtender:: |
public | function |
Sets a condition that the specified field be NULL. Overrides ConditionInterface:: |
|
SelectExtender:: |
public | function |
Indicates if preExecute() has already been called on that object. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Default Join against another table in the database. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Left Outer Join against another table in the database. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Returns the next placeholder ID for the query. Overrides PlaceholderInterface:: |
|
SelectExtender:: |
public | function |
Sets a condition that the specified subquery returns no values. Overrides ConditionInterface:: |
|
SelectExtender:: |
public | function |
Creates a new group of conditions ORed together. Overrides ConditionInterface:: |
|
SelectExtender:: |
public | function |
Orders the result set by a given field. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Orders the result set by a random value. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Restricts a query to a given range in the result set. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Add another Select query to UNION to this one. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function |
Returns a unique identifier for this object. Overrides PlaceholderInterface:: |
|
SelectExtender:: |
public | function |
Adds an arbitrary WHERE clause to the query. Overrides ConditionInterface:: |
|
SelectExtender:: |
public | function | Magic override for undefined methods. | |
SelectExtender:: |
public | function |
Clone magic method. Overrides SelectInterface:: |
|
SelectExtender:: |
public | function | 2 | |
SelectExtender:: |
public | function |
Returns a string representation of how the query will be executed in SQL. Overrides SelectInterface:: |
|
ViewsSearchQuery:: |
public | function | Replaces the original condition with a custom one from views recursively. | |
ViewsSearchQuery:: |
public | function |
Returns the conditions property. Overrides SelectExtender:: |
|
ViewsSearchQuery:: |
public | function | Returns the matches property. | |
ViewsSearchQuery:: |
public | function | Executes and returns the protected parseSearchExpression method. | |
ViewsSearchQuery:: |
public | function | Returns the simple property. | |
ViewsSearchQuery:: |
public | function | Returns the words property. |