Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. QueryAggregateInterface.php

function QueryAggregateInterface::aggregate

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

$this The called object.

File

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

Class

QueryAggregateInterface
Defines an interface for aggregated entity queries.

Namespace

Drupal\Core\Entity\Query

Code

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

API Navigation

  • Drupal Core 11.1.x
  • Topics
  • Classes
  • Functions
  • Constants
  • Globals
  • Files
  • Namespaces
  • Deprecated
  • Services
RSS feed
Powered by Drupal