public function SelectExtender::condition

Helper function: builds the most common conditional clauses.

This method can take a variable number of parameters. If called with two parameters, they are taken as $field and $value with $operator having a value of IN if $value is an array and = otherwise.

Do not use this method to test for NULL values. Instead, use QueryConditionInterface::isNull() or QueryConditionInterface::isNotNull().

Parameters

$field: The name of the field to check. If you would like to add a more complex condition involving operators or functions, use where().

$value: The value to test the field against. In most cases, this is a scalar. For more complex options, it is an array. The meaning of each element in the array is dependent on the $operator.

$operator: The comparison operator, such as =, <, or >=. It also accepts more complex options such as IN, LIKE, or BETWEEN. Defaults to IN if $value is an array, and = otherwise.

Return value

QueryConditionInterface The called object.

Overrides ConditionInterface::condition

See also

Drupal\Core\Database\Query\ConditionInterface::isNull()

Drupal\Core\Database\Query\ConditionInterface::isNotNull()

3 calls to SelectExtender::condition()
SearchQuery::execute in drupal/core/modules/search/lib/Drupal/search/SearchQuery.php
Executes the search.
SearchQuery::executeFirstPass in drupal/core/modules/search/lib/Drupal/search/SearchQuery.php
Executes the first pass query.
SearchQuery::setOption in drupal/core/modules/search/lib/Drupal/search/SearchQuery.php
Applies a search option and removes it from the search query string.

File

drupal/core/lib/Drupal/Core/Database/Query/SelectExtender.php, line 91
Definition of Drupal\Core\Database\Query\SelectExtender

Class

SelectExtender
The base extender class for Select queries.

Namespace

Drupal\Core\Database\Query

Code

public function condition($field, $value = NULL, $operator = NULL) {
  $this->query
    ->condition($field, $value, $operator);
  return $this;
}