public function SelectQueryExtender::orderBy in Drupal 7

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". Any other value will be converted to "ASC".

Return value

SelectQueryInterface The called object.

Overrides SelectQueryInterface::orderBy

2 calls to SelectQueryExtender::orderBy()

SearchQuery::execute in modules/search/search.extender.inc

Executes the search.

TableSort::orderByHeader in includes/tablesort.inc

Order the query based on a header array.

File

includes/database/select.inc, line 765

Class

SelectQueryExtender

The base extender class for Select queries.

Code

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