-
Notifications
You must be signed in to change notification settings - Fork 142
/
SortablePage.class.php
107 lines (91 loc) · 2.33 KB
/
SortablePage.class.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
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
<?php
namespace wcf\page;
use wcf\system\event\EventHandler;
use wcf\system\WCF;
/**
* Provides default implementations for a sortable page of listed items.
* Handles the sorting parameters automatically.
*
* @author Marcel Werk
* @copyright 2001-2019 WoltLab GmbH
* @license GNU Lesser General Public License <http://opensource.org/licenses/lgpl-license.php>
*/
abstract class SortablePage extends MultipleLinkPage
{
/**
* default sort field
* @var string
*/
public $defaultSortField = '';
/**
* default sort order
* @var string
*/
public $defaultSortOrder = 'ASC';
/**
* list of valid sort fields
* @var string[]
*/
public $validSortFields = [];
/**
* @inheritDoc
*/
public function readParameters()
{
parent::readParameters();
// read sorting parameter
if (isset($_REQUEST['sortField'])) {
$this->sortField = $_REQUEST['sortField'];
}
if (isset($_REQUEST['sortOrder'])) {
$this->sortOrder = $_REQUEST['sortOrder'];
}
}
/**
* @inheritDoc
*/
public function readData()
{
$this->validateSortOrder();
$this->validateSortField();
parent::readData();
}
/**
* Validates the given sort field parameter.
*/
public function validateSortField()
{
// call validateSortField event
EventHandler::getInstance()->fireAction($this, 'validateSortField');
if (!\in_array($this->sortField, $this->validSortFields)) {
$this->sortField = $this->defaultSortField;
}
}
/**
* Validates the given sort order parameter.
*/
public function validateSortOrder()
{
// call validateSortOrder event
EventHandler::getInstance()->fireAction($this, 'validateSortOrder');
switch ($this->sortOrder) {
case 'ASC':
case 'DESC':
break;
default:
$this->sortOrder = $this->defaultSortOrder;
}
}
/**
* @inheritDoc
*/
public function assignVariables()
{
parent::assignVariables();
// assign sorting parameters
WCF::getTPL()->assign([
'sortField' => $this->sortField,
'sortOrder' => $this->sortOrder,
]);
}
}