public function SelectQuery::condition

You are here

7 select.inc public SelectQuery::condition($field, $value = NULL, $operator = NULL)

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 QueryConditionInterface::condition

See also

QueryConditionInterface::isNull()

QueryConditionInterface::isNotNull()

File

includes/database/select.inc, line 1006

Class

SelectQuery
Query builder for SELECT statements.

Code

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