You are here

public function SelectExtender::getGroupBy in Drupal 10

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Database/Query/SelectExtender.php \Drupal\Core\Database\Query\SelectExtender::getGroupBy()
  2. 9 core/lib/Drupal/Core/Database/Query/SelectExtender.php \Drupal\Core\Database\Query\SelectExtender::getGroupBy()

Returns a reference to the group-by array for this query.

Because this method returns by reference, alter hooks may edit the group-by array directly to make their changes. If just adding additional grouping fields, however, the use of groupBy() is preferred.

Note that this method must be called by reference as well:

$fields =& $query
  ->getGroupBy();

Return value

A reference to the group-by array structure.

Overrides SelectInterface::getGroupBy

File

core/lib/Drupal/Core/Database/Query/SelectExtender.php, line 259

Class

SelectExtender
The base extender class for Select queries.

Namespace

Drupal\Core\Database\Query

Code

public function &getGroupBy() {
  return $this->query
    ->getGroupBy();
}