public function SelectExtender::orderBy

Orders the result set by a given field.

If called multiple times, the query will order by each specified field in the order this method is called.

If the query uses DISTINCT or GROUP BY conditions, fields or expressions that are used for the order must be selected to be compatible with some databases like PostgreSQL. The PostgreSQL driver can handle simple cases automatically but it is suggested to explicitly specify them. Additionally, when ordering on an alias, the alias must be added before orderBy() is called.

Parameters

$field: The field on which to order.

$direction: The direction to sort. Legal values are "ASC" and "DESC".

Return value

Drupal\Core\Database\Query\SelectInterface The called object.

Overrides SelectInterface::orderBy

2 calls to SelectExtender::orderBy()
SearchQuery::execute in drupal/core/modules/search/lib/Drupal/search/SearchQuery.php
Executes the search.
TableSortExtender::orderByHeader in drupal/core/lib/Drupal/Core/Database/Query/TableSortExtender.php
Order the query based on a header array.

File

drupal/core/lib/Drupal/Core/Database/Query/SelectExtender.php, line 240
Definition of Drupal\Core\Database\Query\SelectExtender

Class

SelectExtender
The base extender class for Select queries.

Namespace

Drupal\Core\Database\Query

Code

public function orderBy($field, $direction = 'ASC') {
  $this->query
    ->orderBy($field, $direction);
  return $this;
}