-
Notifications
You must be signed in to change notification settings - Fork 3
/
externallib.php
241 lines (217 loc) · 8.72 KB
/
externallib.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
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
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
<?php
// This file is part of block_semester_sortierung for Moodle - http://moodle.org/
//
// Moodle is free software: you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// Moodle is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
/**
* External API functions
*
* @package block_semester_sortierung
* @author Andreas Hruska ([email protected])
* @author Katarzyna Potocka ([email protected])
* @author Simeon Naydenov ([email protected])
* @copyright 2014 Academic Moodle Cooperation {@link http://www.academic-moodle-cooperation.org}
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
defined('MOODLE_INTERNAL') || die;
require_once("$CFG->libdir/externallib.php");
class block_semester_sortierung_external extends external_api {
/**
* Describes the parameters for get_modules.
*
* @return external_function_parameters
* @since Moodle 3.0
*/
public static function get_modules_parameters() {
return new external_function_parameters (
array()
);
}
/**
* Returns a list of all active modules
*
* @return array the forum details
* @since Moodle 3.0
*/
public static function get_modules() {
global $CFG, $DB, $OUTPUT;
$modules = $DB->get_records('modules', array('visible' => 1));
$result = array();
$CFG->svgicons = false;
foreach ($modules as $module) {
$m = new stdClass;
$m->name = $module->name;
$m->title_en = (new lang_string('pluginname',
'mod_' . $module->name,
null,
'en'))->out();
$m->title_de = (new lang_string('pluginname',
'mod_' . $module->name,
null,
'de'))->out();
$m->image = base64_encode(file_get_contents($OUTPUT->image_url('icon', 'mod_' . $module->name)));
if (empty($m->image)) {
$imagepath = $CFG->dirroot . '/mod/' . $module->name . '/pix/icon.';
if (file_exists($imagepath . 'png')) {
$m->image = base64_encode(file_get_contents($imagepath . 'png'));
} else if (file_exists($imagepath . 'gif')) {
$m->image = base64_encode(file_get_contents($imagepath . 'gif'));
}
}
$result[] = $m;
}
return $result;
}
/**
* Describes the get_modules return value.
*
* @return external_single_structure
* @since Moodle 2.5
*/
public static function get_modules_returns() {
return new external_multiple_structure(
new external_single_structure(
array(
'name' => new external_value(PARAM_TEXT, 'Short one-word name of module'),
'title_en' => new external_value(PARAM_TEXT, 'Module title in english'),
'title_de' => new external_value(PARAM_TEXT, 'Module title in german'),
'image' => new external_value(PARAM_RAW, 'Module image')
), 'module'
)
);
}
/**
* Describes the parameters for get_courses.
*
* @return external_function_parameters
* @since Moodle 3.0
*/
public static function get_courses_parameters() {
return new external_function_parameters (
array('userid' => new external_value(PARAM_TEXT, 'user id', VALUE_REQUIRED))
);
}
/**
* Returns a list of user courses
*
* @return array the forum details
* @since Moodle 3.0
*/
public static function get_courses($userid) {
global $CFG, $DB, $OUTPUT;
require_once(__DIR__ . '/locallib.php');
$user = $DB->get_record('user', array('username' => $userid));
// Get the information about the enrolled courses.
$courses = enrol_get_all_users_courses($user->id, false , 'id, fullname, shortname, idnumber, summary');
$config = get_config('block_semester_sortierung');
// Add the semester to each course.
$courses = block_semester_sortierung_fill_course_semester($courses, $config);
$result = array();
foreach ($courses as $semester => $seminfo) {
if ($semester == 'fav') {
continue;
}
foreach ($seminfo['courses'] as $semcourse) {
$course = new stdClass;
$course->coursenumber = $semcourse->idnumber;
$course->coursename = $semcourse->fullname;
$course->description = $semcourse->summary;
$course->courseid = $semcourse->id;
$course->semestercode = $semcourse->semester_short;
$result[] = $course;
}
}
return $result;
}
/**
* Describes the get_courses return value.
*
* @return external_single_structure
* @since Moodle 2.5
*/
public static function get_courses_returns() {
return new external_multiple_structure(
new external_single_structure(
array(
'coursename' => new external_value(PARAM_TEXT, 'Name of course'),
'semestercode' => new external_value(PARAM_RAW, 'Semester code'),
'coursenumber' => new external_value(PARAM_RAW, 'Course number'),
'courseid' => new external_value(PARAM_INT, 'Database unique course id'),
'description' => new external_value(PARAM_RAW, 'Course description')
), 'course'
)
);
}
/**
* Describes the parameters for get_coursedetails.
*
* @return external_function_parameters
* @since Moodle 3.0
*/
public static function get_coursedetails_parameters() {
return new external_function_parameters (
array(
'userid' => new external_value(PARAM_TEXT, 'user id', VALUE_REQUIRED),
'courseid' => new external_value(PARAM_INT, 'course id', VALUE_REQUIRED)
)
);
}
/**
* Returns a list of user courses
*
* @return array the forum details
* @since Moodle 3.0
*/
public static function get_coursedetails($userid, $courseid) {
global $CFG, $DB, $OUTPUT, $USER, $PAGE;
require_once(__DIR__ . '/locallib.php');
$user = $DB->get_record('user', array('username' => $userid));
$courses = $DB->get_records('course', array('id' => $courseid));
if (!$user || empty($courses)) {
return array();
}
$context = \context_course::instance($courseid);
self::validate_context($context);
$olduser = $USER;
$GLOBALS['USER'] = $user; // Note for codechecker - GLOBALS is a php reserved variable, can't really change it.
$result = array();
$output = $PAGE->get_renderer('block_semester_sortierung');
$expandedevents = block_semester_sortierung_get_courses_events($courses, $output);
if (isset($expandedevents[$courseid]) && !empty($expandedevents[$courseid]->events)) {
foreach ($expandedevents[$courseid]->events as $event) {
$mod = new \stdClass;
$mod->modname = $event->modulename;
$mod->modinfo = $output->render_from_template('block_semester_sortierung/course-event-list-item-clean', $event);
$result[] = $mod;
}
}
$GLOBALS['USER'] = $olduser; // Note for codechecker - GLOBALS is a php reserved variable, can't really change it.
return $result;
}
/**
* Describes the get_coursedetails return value.
*
* @return external_single_structure
* @since Moodle 2.5
*/
public static function get_coursedetails_returns() {
return new external_multiple_structure(
new external_single_structure(
array(
'modname' => new external_value(PARAM_TEXT, 'Name of module'),
'modinfo' => new external_value(PARAM_RAW, 'Module information')
), 'module'
)
);
}
}