Skip to content

Commit 1b1424b

Browse files
irinahpeirinahpe
authored
Add files via upload
1 parent 5a01fd7 commit 1b1424b

File tree

5 files changed

+193
-0
lines changed

5 files changed

+193
-0
lines changed

‎classes/external/get_completion_for_courseid.php

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
<?php
2+
3+
namespace local_webservices\external;
4+
5+
use context_course;
6+
use core\oauth2\access_token;
7+
use core_course\analytics\target\course_completion;
8+
use external_function_parameters;
9+
use external_multiple_structure;
10+
use external_single_structure;
11+
use external_value;
12+
13+
use core\plugininfo\webservice;
14+
15+
class get_completion_for_courseid extends \core_external\external_api {
16+
17+
/**
18+
* Returns description of method parameters
19+
* @return external_function_parameters
20+
*/
21+
22+
public static function execute_parameters() {
23+
return new external_function_parameters([
24+
'courseid' => new external_value(PARAM_INT, 'id of course')
25+
]);
26+
}
27+
28+
public static function execute($courseid) {
29+
30+
global $CFG, $DB, $USER;
31+
32+
$params = self::validate_parameters(self::execute_parameters(), ['courseid' => $courseid]);
33+
34+
$transaction = $DB->start_delegated_transaction();
35+
36+
$coursecontext = context_course::instance($courseid);
37+
38+
require_capability('report/completion:view', $coursecontext);
39+
40+
$users = get_enrolled_users($coursecontext, '', 0, 'u.id, u.username');
41+
42+
//Fetch completionstates for all users in this course.
43+
$sql = "SELECT DISTINCT u.username as username, cc.timecompleted as completiondate,
44+
case
45+
when cc.timecompleted IS NULL then 0
46+
when cc.timecompleted IS NOT NULL then 1
47+
end as completionstatus FROM {user} u
48+
INNER JOIN {course_completions} cc ON u.id = cc.userid AND cc.course= :courseid
49+
WHERE u.id IN :userids";
50+
51+
$results = $DB->get_records_sql($sql, [
52+
'courseid' => $courseid,
53+
'userids' => implode(", ", array_map(function($user) {
54+
return $user->id;
55+
},$users))
56+
]);
57+
58+
$transaction->allow_commit();
59+
60+
return $results;
61+
}
62+
63+
public static function execute_returns() {
64+
return new external_multiple_structure(
65+
new external_single_structure(
66+
array(
67+
'username' => new external_value(PARAM_TEXT, 'username'),
68+
'completiondate' => new external_value(PARAM_TEXT, 'date of completion'),
69+
'completionstatus' => new external_value(PARAM_BOOL, 'completionstatus')
70+
)
71+
)
72+
);
73+
}
74+
75+
}
76+

‎db/services.php

+35
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
<?php
2+
// This file is part of Moodle - http://moodle.org/
3+
//
4+
// Moodle is free software: you can redistribute it and/or modify
5+
// it under the terms of the GNU General Public License as published by
6+
// the Free Software Foundation, either version 3 of the License, or
7+
// (at your option) any later version.
8+
//
9+
// Moodle is distributed in the hope that it will be useful,
10+
// but WITHOUT ANY WARRANTY; without even the implied warranty of
11+
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12+
// GNU General Public License for more details.
13+
//
14+
// You should have received a copy of the GNU General Public License
15+
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16+
17+
/**
18+
* Web service function declarations for the local_webservices plugin
19+
*
20+
* @package local_webservices
21+
* @copyright 2023 Irina Hoppe Uni Münster
22+
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23+
*/
24+
25+
$functions = [
26+
'local_webservices_get_completion_for_courseid' => [
27+
'classname' => 'local_webservices\external\get_completion_for_courseid',
28+
'description' => 'Returns the course completionstatus of all users in the course matching this courseid.',
29+
'type' => 'read',
30+
'ajax' => true,
31+
'services' => [
32+
MOODLE_OFFICIAL_MOBILE_SERVICE
33+
]
34+
]
35+
];

‎lang/en/local_ws_completionforcourseid.php

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<?php
2+
// This file is part of Moodle - http://moodle.org/
3+
//
4+
// Moodle is free software: you can redistribute it and/or modify
5+
// it under the terms of the GNU General Public License as published by
6+
// the Free Software Foundation, either version 3 of the License, or
7+
// (at your option) any later version.
8+
//
9+
// Moodle is distributed in the hope that it will be useful,
10+
// but WITHOUT ANY WARRANTY; without even the implied warranty of
11+
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12+
// GNU General Public License for more details.
13+
//
14+
// You should have received a copy of the GNU General Public License
15+
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16+
17+
/**
18+
* Language strings
19+
*
20+
* @package local_ws_completionforcourseid
21+
* @category string
22+
* @copyright 2023 Irina Hoppe Uni Münster
23+
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24+
*
25+
*/
26+
27+
$string['pluginname'] = 'local_ws_completionforcourseid';

‎lib.php

+24
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
<?php
2+
// This file is part of Moodle - http://moodle.org/
3+
//
4+
// Moodle is free software: you can redistribute it and/or modify
5+
// it under the terms of the GNU General Public License as published by
6+
// the Free Software Foundation, either version 3 of the License, or
7+
// (at your option) any later version.
8+
//
9+
// Moodle is distributed in the hope that it will be useful,
10+
// but WITHOUT ANY WARRANTY; without even the implied warranty of
11+
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12+
// GNU General Public License for more details.
13+
//
14+
// You should have received a copy of the GNU General Public License
15+
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16+
17+
/**
18+
* Functions that aid core functionality
19+
*
20+
* @package local_webservices
21+
* @copyright 2023 Irina Hoppe Uni Münster
22+
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23+
*/
24+
defined('MOODLE_INTERNAL') || die();

‎version.php

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
<?php
2+
// This file is part of Moodle - http://moodle.org/
3+
//
4+
// Moodle is free software: you can redistribute it and/or modify
5+
// it under the terms of the GNU General Public License as published by
6+
// the Free Software Foundation, either version 3 of the License, or
7+
// (at your option) any later version.
8+
//
9+
// Moodle is distributed in the hope that it will be useful,
10+
// but WITHOUT ANY WARRANTY; without even the implied warranty of
11+
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12+
// GNU General Public License for more details.
13+
//
14+
// You should have received a copy of the GNU General Public License
15+
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
16+
17+
/**
18+
* Version details.
19+
*
20+
* @package local
21+
* @subpackage webservices
22+
* @copyright 2023 Irina Hoppe Uni Münster
23+
*/
24+
25+
defined('MOODLE_INTERNAL') || die;
26+
27+
$plugin->version = 2023121100;
28+
$plugin->requires = 2020062500; //Requires Moodle 3.9+.
29+
$plugin->component = 'local_webservices';
30+
$plugin->release = 'v4.2-r1';
31+
$plugin->maturity = MATURITY_ALPHA;

0 commit comments

Comments
 (0)