blob: 9cce3d0215b166f9221fc4e713387e36f7ad59e3 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
|
<?php
namespace ipl\Sql;
/**
* Interface for the ORDER BY part of a query
*/
interface OrderByInterface
{
/**
* Get whether a ORDER BY part is configured
*
* @return bool
*/
public function hasOrderBy();
/**
* Get the ORDER BY part of the query
*
* @return array|null
*/
public function getOrderBy();
/**
* Set the ORDER BY part of the query - either plain columns or expressions or scalar subqueries
*
* Note that this method does not override an already set ORDER BY part. Instead, each call to this function
* appends the specified ORDER BY part to an already existing one.
*
* This method does NOT quote the columns you specify for the ORDER BY.
* If you allow user input here, you must protected yourself against SQL injection using
* {@link Connection::quoteIdentifier()} for the field names passed to this method.
* If you are using special field names, e.g. reserved keywords for your DBMS, you are required to use
* {@link Connection::quoteIdentifier()} as well.
*
* @param string|array $orderBy The ORDER BY part. The items can be in any format of the following:
* ['column', 'column' => 'DESC', 'column' => SORT_DESC, ['column', 'DESC']]
* @param string|int $direction The default direction. Can be any of the following:
* 'ASC', 'DESC', SORT_ASC, SORT_DESC
*
* @return $this
*/
public function orderBy($orderBy, $direction = null);
/**
* Reset the ORDER BY part of the query
*
* @return $this
*/
public function resetOrderBy();
}
|
