W3cubDocs

/Drupal 8

public function QueryBase::sortAggregate

public QueryBase::sortAggregate($field, $function, $direction = 'ASC', $langcode = NULL)

Sorts by an aggregated value.

Parameters

string $field: The name of a field.

string $function: The aggregate function. This is only marked optional for interface compatibility, it is illegal to leave it out.

string $direction: The order of sorting, either DESC for descending of ASC for ascending.

string $langcode: (optional) The language code.

Return value

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

Overrides QueryAggregateInterface::sortAggregate

File

core/lib/Drupal/Core/Entity/Query/QueryBase.php, line 407

Class

QueryBase
The base entity query class.

Namespace

Drupal\Core\Entity\Query

Code

public function sortAggregate($field, $function, $direction = 'ASC', $langcode = NULL) {
  $alias = $this->getAggregationAlias($field, $function);

  $this->sortAggregate[$alias] = array(
    'field' => $field,
    'function' => $function,
    'direction' => $direction,
    'langcode' => $langcode,
  );
  $this->aggregate($field, $function, $langcode, $alias);

  return $this;
}

© 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!QueryBase.php/function/QueryBase::sortAggregate/8.1.x