function SelectInterface::getGroupBy

Same name in other branches
  1. 8.9.x core/lib/Drupal/Core/Database/Query/SelectInterface.php \Drupal\Core\Database\Query\SelectInterface::getGroupBy()
  2. 10 core/lib/Drupal/Core/Database/Query/SelectInterface.php \Drupal\Core\Database\Query\SelectInterface::getGroupBy()
  3. 11.x core/lib/Drupal/Core/Database/Query/SelectInterface.php \Drupal\Core\Database\Query\SelectInterface::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

array A reference to the group-by array structure.

2 methods override SelectInterface::getGroupBy()
Select::getGroupBy in core/lib/Drupal/Core/Database/Query/Select.php
Returns a reference to the group-by array for this query.
SelectExtender::getGroupBy in core/lib/Drupal/Core/Database/Query/SelectExtender.php
Returns a reference to the group-by array for this query.

File

core/lib/Drupal/Core/Database/Query/SelectInterface.php, line 86

Class

SelectInterface
Interface definition for a Select Query object.

Namespace

Drupal\Core\Database\Query

Code

public function &getGroupBy();

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