function Select::havingCondition

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Database/Query/Select.php \Drupal\Core\Database\Query\Select::havingCondition()
  2. 8.9.x core/lib/Drupal/Core/Database/Query/Select.php \Drupal\Core\Database\Query\Select::havingCondition()
  3. 11.x core/lib/Drupal/Core/Database/Query/Select.php \Drupal\Core\Database\Query\Select::havingCondition()

Helper function to build most common HAVING 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.

Parameters

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

$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 = otherwise.

Return value

\Drupal\Core\Database\Query\ConditionInterface The called object.

Overrides SelectInterface::havingCondition

File

core/lib/Drupal/Core/Database/Query/Select.php, line 296

Class

Select
Query builder for SELECT statements.

Namespace

Drupal\Core\Database\Query

Code

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

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.