1: <?php
 2: /**
 3:  * The MIT License
 4:  *
 5:  * Copyright 2017 David Schoenbauer.
 6:  *
 7:  * Permission is hereby granted, free of charge, to any person obtaining a copy
 8:  * of this software and associated documentation files (the "Software"), to deal
 9:  * in the Software without restriction, including without limitation the rights
10:  * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
11:  * copies of the Software, and to permit persons to whom the Software is
12:  * furnished to do so, subject to the following conditions:
13:  *
14:  * The above copyright notice and this permission notice shall be included in
15:  * all copies or substantial portions of the Software.
16:  *
17:  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
18:  * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
19:  * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
20:  * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
21:  * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
22:  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
23:  * THE SOFTWARE.
24:  */
25: namespace DSchoenbauer\Orm\Entity;
26: 
27: /**
28:  * provides a way to define whish fields of an entity are sortable
29:  * @author David Schoenbauer <d.schoenbauer@ctimeetingtech.com>
30:  */
31: interface IsSortableInterface
32: {
33:     const SORT_ASCENDING = "ASC";
34:     const SORT_DESCENDING = "DESC";
35:     
36:     /**
37:      * provides a list of fields that can be sorted
38:      * @return array an array of fields that can be sorted
39:      * @since v1.0.0
40:      */
41:     public function getSortFields();
42: 
43:     /**
44:      * provides a the default field to sort on
45:      * @return string if no field is provided by the user this field will define
46:      * which field should be sorted on
47:      * @since v1.0.0
48:      */
49:     public function getDefaultSortField();
50: 
51:     /**
52:      * defines a default sort order
53:      * @return string returns either IsSortableInterface::SORT_ASCENDING or IsSortableInterface::SORT_DESCENDING
54:      * @since v1.0.0
55:      */
56:     public function getDefaultSortDirection();
57: }
58: