W3cubDocs

/Drupal 8

public function QueryAggregateInterface::aggregate

public QueryAggregateInterface::aggregate($field, $function, $langcode = NULL, &$alias = NULL)

Specifies a field and a function to aggregate on.

Available functions: SUM, AVG, MIN, MAX and COUNT.

@todo What about GROUP_CONCAT support?

Parameters

string $field: The name of the field to aggregate by.

string $function: The aggregation function, for example COUNT or MIN.

string $langcode: (optional) The language code.

string $alias: (optional) The key that will be used on the resultset.

Return value

\Drupal\Core\Entity\Query\QueryAggregateInterface The called object.

File

core/lib/Drupal/Core/Entity/Query/QueryAggregateInterface.php, line 29

Class

QueryAggregateInterface
Defines a interface for aggregated entity queries.

Namespace

Drupal\Core\Entity\Query

Code

public function aggregate($field, $function, $langcode = NULL, &$alias = NULL);

© 2001–2016 by the original authors
Licensed under the GNU General Public License, version 2 and later.
Drupal is a registered trademark of Dries Buytaert.
https://api.drupal.org/api/drupal/core!lib!Drupal!Core!Entity!Query!QueryAggregateInterface.php/function/QueryAggregateInterface::aggregate/8.1.x