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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
<?php
/**
* SemesterSelectorWidget
*
* This class defines a standard sidebar widget for choosing a semester.
* The selector is derived from the more generic SelecWidget.
*
* @author Jan-Hendrik Willms <tleilax+studip@gmail.com>
* @see SelectWidget
* @since Stud.IP 3.2
* @license GPL2 or any later version
* @copyright Stud.IP Core Group
*/
class SemesterSelectorWidget extends SelectWidget
{
protected $include_all = false;
/**
* The timestamp of the first semester that shall be selectable.
*/
protected $semester_range_begin = 0;
/**
* The timestamp of the last semester that shall be selectable.
*/
protected $semester_range_end = 0;
/**
* @var bool Whether the lecture period in a semester can be selected
* separately (true) or not (false). Defaults to false.
*/
protected bool $lecture_period_selectable = false;
/**
* @var bool Whether the vacation period after the lecturing time in a
* semester can be selected separately (true) or not (false).
* Defaults to false.
*/
protected bool $vacation_period_selectable = false;
/**
* Overrides parent constructor by setting a default title and default
* name.
*/
public function __construct($url, $name = 'semester_id', $method = 'get')
{
parent::__construct(_('Semester auswählen'), $url, $name, $method);
}
/**
* Should the list include an option for all semesters which results in
* an option with a value of '0'.
*/
public function includeAll($state = true)
{
$this->include_all = $state;
}
/**
* Sets the range of semesters to be displayed.
*
* @param $semester_range_begin The timestamp of the first semester.
*
* @param $semester_range_end The timestamp of the end semester.
*/
public function setRange($semester_range_begin, $semester_range_end)
{
if ($semester_range_end >= $semester_range_begin) {
$this->semester_range_begin = $semester_range_begin;
$this->semester_range_end = $semester_range_end;
}
}
/**
* Makes the lecture period in the semester selectable separately.
*/
public function makeLecturePeriodSelectable() : void
{
$this->lecture_period_selectable = true;
}
/**
* Makes the vacation period after the lecture period selectable separately.
*/
public function makeVacationPeriodSelectable() : void
{
$this->vacation_period_selectable = true;
}
/**
* Populates and renders the widget according to the previously made
* settings.
*/
public function render($variables = [])
{
$current_id = Request::get($this->template_variables['name']);
if (!$current_id) {
if (!empty($this->template_variables['value'])) {
$current_id = $this->template_variables['value'];
} elseif (!$this->include_all) {
$current_id = Semester::findCurrent()->id;
}
}
if ($this->include_all) {
$element = new SelectElement(0, _('Alle Semester'), !$current_id);
$this->addElement($element);
}
if ($this->semester_range_begin && $this->semester_range_end) {
$semesters = Semester::findBySql(
'`beginn` BETWEEN :begin AND :end
OR
`ende` BETWEEN :begin AND :end
ORDER BY `beginn` DESC',
[
'begin' => $this->semester_range_begin,
'end' => $this->semester_range_end
]
);
} else {
$semesters = array_reverse(Semester::getAll());
}
foreach ($semesters as $semester) {
if ($this->vacation_period_selectable) {
$id_with_suffix = sprintf('%s_vacation', $semester->id);
$element = new SelectElement(
$id_with_suffix,
studip_interpolate(_('Vorlesungsfrei nach %{semester_name}'), ['semester_name' => $semester->name]),
$current_id && $id_with_suffix === $current_id
);
$this->addElement($element);
}
if ($this->lecture_period_selectable) {
$id_with_suffix = sprintf('%s_lecture', $semester->id);
$element = new SelectElement(
$id_with_suffix,
studip_interpolate(_('%{semester_name} (Vorlesungszeit)'), ['semester_name' => $semester->name]),
$current_id && $id_with_suffix === $current_id
);
$this->addElement($element);
}
$element = new SelectElement($semester->id, $semester->name, $current_id && $semester->id === $current_id);
$this->addElement($element);
}
return parent::render($variables);
}
}
|
