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
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
<?php
namespace JsonApi\Routes\Tree;
use JsonApi\Errors\BadRequestException;
use Psr\Http\Message\ServerRequestInterface as Request;
use Psr\Http\Message\ResponseInterface as Response;
use JsonApi\Errors\AuthorizationFailedException;
use JsonApi\Errors\RecordNotFoundException;
use JsonApi\JsonApiController;
use StudipTreeNode;
class CoursesOfTreeNode extends JsonApiController
{
protected $allowUnrecognizedParams = true;
protected $allowedFilteringParameters = [
'q',
'semester',
'semclass',
'recursive',
'ids',
];
protected $allowedIncludePaths = [
'blubber-threads',
'end-semester',
'events',
'feedback-elements',
'file-refs',
'folders',
'forum-categories',
'institute',
'memberships',
'news',
'participating-institutes',
'sem-class',
'sem-type',
'start-semester',
'status-groups',
'wiki-pages',
];
protected $allowedPagingParameters = ['offset', 'limit'];
/**
* @SuppressWarnings(PHPMD.UnusedFormalParameters)
*/
public function __invoke(Request $request, Response $response, $args)
{
/**
* @var class-string<StudipTreeNode> $classname
*/
[$classname, $id] = explode('_', $args['id']);
if (!class_exists($classname) || !is_subclass_of($classname, StudipTreeNode::class)) {
throw new BadRequestException('Invalid class name.');
}
$node = $classname::getNode($id);
if (!$node) {
throw new RecordNotFoundException();
}
$error = $this->validateFilters();
if ($error) {
throw new BadRequestException($error);
}
$filters = $this->getContextFilters();
[$offset, $limit] = $this->getOffsetAndLimit();
$courses = \SimpleCollection::createFromArray(
$node->getCourses(
$filters['semester'],
(int) $filters['semclass'],
$filters['q'],
(bool) $filters['recursive'],
$filters['ids']
)
);
return $this->getPaginatedContentResponse(
$courses->limit($offset, $limit),
count($courses)
);
}
private function validateFilters()
{
$filtering = $this->getQueryParameters()->getFilteringParameters() ?: [];
// keyword aka q
if (isset($filtering['q']) && mb_strlen($filtering['q']) < 3) {
return 'Search term too short.';
}
// semester
if (isset($filtering['semester']) && $filtering['semester'] !== 'all') {
$semester = \Semester::find($filtering['semester']);
if (!$semester) {
return 'Invalid "semester".';
}
}
// course category
if (!empty($filtering['semclass'])) {
$semclass = \SeminarCategories::Get($filtering['semclass']);
if (!$semclass) {
return 'Invalid "course category".';
}
}
}
private function getContextFilters(): array
{
$defaults = [
'q' => '',
'semester' => 'all',
'semclass' => 0,
'recursive' => false,
'ids' => []
];
$filtering = $this->getQueryParameters()->getFilteringParameters() ?: [];
return array_merge($defaults, $filtering);
}
}
|
