-
Notifications
You must be signed in to change notification settings - Fork 0
/
OrderCollectionInterface.php
52 lines (45 loc) · 1.32 KB
/
OrderCollectionInterface.php
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
52
<?php
namespace Charcoal\Source;
use InvalidArgumentException;
/**
* Describes an order expression list.
*/
interface OrderCollectionInterface
{
/**
* Replace the query order(s) on this object.
*
* Note: Any existing orders are dropped.
*
* @param array $orders One or more orders to set on this expression.
* @return OrderCollectionInterface Returns the current expression.
*/
public function setOrders(array $orders);
/**
* Append one or more query orders on this object.
*
* @param array $orders One or more orders to add on this expression.
* @return OrderCollectionInterface Returns the current expression.
*/
public function addOrders(array $orders);
/**
* Append a query order on this object.
*
* @param mixed $order The order expression string, structure, object, or callable to append.
* @throws InvalidArgumentException If the order is invalid.
* @return OrderCollectionInterface Returns the current expression.
*/
public function addOrder($order);
/**
* Determine if the object has any query orders.
*
* @return boolean
*/
public function hasOrders();
/**
* Retrieve the query orders stored in this object.
*
* @return array
*/
public function orders();
}