blob: 1d13c998e666106c8d2df613ae2d3f9bb6aadeb5 (
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
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
|
<?php
/**
* Interface StudipTreeNode
* An abstract representation of a tree node in Stud.IP
*
* @author Thomas Hackl <hackl@data-quest.de>
* @license GPL2 or any later version
* @since Stud.IP 5.3
*/
interface StudipTreeNode
{
/**
* Fetches a node by the given ID. The implementing class knows what to do.
*
* @param mixed $id
* @return StudipTreeNode
*/
public static function getNode($id): StudipTreeNode;
/**
* Get all direct children of the given node.
*
* @param bool $onlyVisible fetch only visible nodes?
* @return StudipTreeNode[]
*/
public function getChildNodes(bool $onlyVisible = false): array;
/**
* Fetches an array of all nodes the given course is assigned to.
*
* @param string $course_id
* @return array
*/
public static function getCourseNodes(string $course_id): array;
/**
* This node's unique ID.
*
* @return mixed
*/
public function getId();
/**
* A name (=label) for this node.
*
* @return string
*/
public function getName(): string;
/**
* Optional description for this node.
*
* @return string
*/
public function getDescription(): string;
/**
* Gets an optional Image (Icon or Avatar) for this node.
*
* @return Icon|Avatar|null
*/
public function getImage();
/**
* Indicator if this node has children.
*
* @return bool
*/
public function hasChildNodes(): bool;
/**
* How many courses are assigned to this node in the given semester?
*
* @param string $semester_id
* @param int $semclass
* @param bool $with_children
* @return int
*/
public function countCourses(
string $semester_id = '',
int $semclass = 0,
bool $with_children = false
): int;
/**
* Fetches courses assigned to this node in the given semester.
*
* @param string $semester_id
* @param int $semclass
* @param string $searchterm
* @param bool $with_children
* @param string[] $courses
*
* @return Course[]
*/
public function getCourses(
string $semester_id = 'all',
int $semclass = 0,
string $searchterm = '',
bool $with_children = false,
array $courses = []
): array;
/**
* Returns an array containing all ancestor nodes with id and name.
*
* @return array
*/
public function getAncestorNodes(): array;
/**
* Returns an array containing all descendant node IDs.
*
* @return array
*/
public function getDescendantNodeIds(): array;
}
|
