addOrderBy() public method

Adds additional ORDER BY columns to the query.
See also: orderBy()
public addOrderBy ( string | array $columns )
$columns string | array the columns (and the directions) to be ordered by. Columns can be specified in either a string (e.g. "id ASC, name DESC") or an array (e.g. `['id' => SORT_ASC, 'name' => SORT_DESC]`). The method will automatically quote the column names unless a column contains some parenthesis (which means the column contains a DB expression).
QueryInterface Interface Documentation
Example #1
0
 /**
  * Ajoute à $query les clauses de tri stockées en session
  *
  * @param QueryInterface $query
  * @param string         $sessionKey La clé de session, en principe au format : app\models\MaClasse.sort
  * @return QueryInterface
  */
 public static function updateQuery(QueryInterface $query, $sessionKey)
 {
     // La clé de session contient un tableau au format : nom_colonne => ordre_de_tri
     $sortClauses = Yii::$app->session->get($sessionKey, []);
     foreach ($sortClauses as $field => $clause) {
         if ($clause == 'asc' || $clause == 'desc') {
             $query->addOrderBy($field . ' ' . $clause);
         }
     }
     return $query;
 }