You are here

Home » API reference » Drupal 9 » Select.php » Select

public function Select::getGroupBy in Drupal 9

Same name and namespace in other branches
  1. 8 core/lib/Drupal/Core/Database/Query/Select.php \Drupal\Core\Database\Query\Select::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/Select.php, line 396

Class

Select
Query builder for SELECT statements.

Namespace

Drupal\Core\Database\Query

Code

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