public function views_plugin_query_default::add_orderby in Views (for Drupal 7) 7.3

Same name and namespace in other branches

1. 6.3 plugins/views_plugin_query_default.inc \views_plugin_query_default::add_orderby()

Add an ORDER BY clause to the query.

Parameters

string $table: The table this field is part of. If a formula, enter NULL. If you want to orderby random use "rand" as table and nothing else.

string $field: The field or formula to sort on. If already a field, enter NULL and put in the alias.

string $order: Either ASC or DESC.

string $alias: The alias to add the field as. In SQL, all fields in the order by must also be in the SELECT portion. If an $alias isn't specified one will be generated for from the $field; however, if the $field is a formula, this alias will likely fail.

string $params: Any params that should be passed through to the add_field.

File

plugins/views_plugin_query_default.inc, line 1055

Definition of views_plugin_query_default.

Class

views_plugin_query_default

Object used to create a SELECT query.

Code

public function add_orderby($table, $field = NULL, $order = 'ASC', $alias = '', $params = array()) {

  // Only ensure the table if it's not the special random key.
  // @todo Maybe it would make sense to just add a add_orderby_rand or
  // something similar.
  if ($table && $table != 'rand') {
    $this
      ->ensure_table($table);
  }

  // Only fill out this aliasing if there is a table; otherwise we assume it
  // is a formula.
  if (!$alias && $table) {
    $as = $table . '_' . $field;
  }
  else {
    $as = $alias;
  }
  if ($field) {
    $as = $this
      ->add_field($table, $field, $as, $params);
  }
  $this->orderby[] = array(
    'field' => $as,
    'direction' => strtoupper($order),
  );
}