From 3a2ba746945c6f8c7aea88368ed60fa2a50897b5 Mon Sep 17 00:00:00 2001 From: Juan Leyva Date: Fri, 30 Jan 2015 12:29:56 +0100 Subject: [PATCH] MDL-49036 webservices: New ws gradereport_user_get_grades_table --- grade/report/user/db/services.php | 35 +++++ grade/report/user/externallib.php | 247 ++++++++++++++++++++++++++++++ lib/db/services.php | 3 +- 3 files changed, 284 insertions(+), 1 deletion(-) create mode 100644 grade/report/user/db/services.php create mode 100644 grade/report/user/externallib.php diff --git a/grade/report/user/db/services.php b/grade/report/user/db/services.php new file mode 100644 index 00000000000..52ed7ef5127 --- /dev/null +++ b/grade/report/user/db/services.php @@ -0,0 +1,35 @@ +. + +/** + * User grade report external functions and service definitions. + * + * @package gradereport_user + * @copyright 2015 Juan Leyva + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +$functions = array( + + 'gradereport_user_get_grades_table' => array( + 'classname' => 'gradereport_user_external', + 'methodname' => 'get_grades_table', + 'classpath' => 'grade/report/user/externallib.php', + 'description' => 'Get the user/s report grades table for a course', + 'type' => 'read', + 'capabilities' => 'gradereport/user:view' + ) +); diff --git a/grade/report/user/externallib.php b/grade/report/user/externallib.php new file mode 100644 index 00000000000..0253ad3c1c2 --- /dev/null +++ b/grade/report/user/externallib.php @@ -0,0 +1,247 @@ +. + +/** + * External grade report user API + * + * @package gradereport_user + * @copyright 2015 Juan Leyva + * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later + */ + +defined('MOODLE_INTERNAL') || die; + +require_once("$CFG->libdir/externallib.php"); + +class gradereport_user_external extends external_api { + + /** + * Describes the parameters for get_grades_table. + * + * @return external_external_function_parameters + * @since Moodle 2.9 + */ + public static function get_grades_table_parameters() { + return new external_function_parameters ( + array( + 'courseid' => new external_value(PARAM_INT, 'Course Id', VALUE_REQUIRED), + 'userid' => new external_value(PARAM_INT, 'Return grades only for this user (optional)', VALUE_DEFAULT, 0) + ) + ); + } + + /** + * Returns a list of grades tables for users in a course. + * + * @param int $courseid Course Id + * @param int $userid Only this user (optional) + * + * @return array the grades tables + * @since Moodle 2.9 + */ + public static function get_grades_table($courseid, $userid = 0) { + global $CFG, $USER; + + $warnings = array(); + + // Validate the parameter. + $params = self::validate_parameters(self::get_grades_table_parameters(), + array( + 'courseid' => $courseid, + 'userid' => $userid) + ); + + // Compact/extract functions are not recommended. + $courseid = $params['courseid']; + $userid = $params['userid']; + + // Function get_course internally throws an exception if the course doesn't exist. + $course = get_course($courseid); + + $context = context_course::instance($courseid); + self::validate_context($context); + + // Specific capabilities. + require_capability('gradereport/user:view', $context); + + $user = null; + + if (empty($userid)) { + require_capability('moodle/grade:viewall', $context); + } else { + $user = core_user::get_user($userid, '*', MUST_EXIST); + } + + $access = false; + + if (has_capability('moodle/grade:viewall', $context)) { + // Can view all course grades. + $access = true; + } else if ($userid == $USER->id and has_capability('moodle/grade:view', $context) and $course->showgrades) { + // View own grades. + $access = true; + } + + if (!$access) { + throw new moodle_exception('nopermissiontoviewgrades', 'error'); + } + + // Require files here to save some memory in case validation fails. + require_once($CFG->dirroot . '/group/lib.php'); + require_once($CFG->libdir . '/gradelib.php'); + require_once($CFG->dirroot . '/grade/lib.php'); + require_once($CFG->dirroot . '/grade/report/user/lib.php'); + + $gpr = new grade_plugin_return( + array( + 'type' => 'report', + 'plugin' => 'user', + 'courseid' => $courseid, + 'userid' => $userid) + ); + + $tables = array(); + + // Just one user. + if ($user) { + $report = new grade_report_user($courseid, $gpr, $context, $userid); + $report->fill_table(); + + $tables[] = array( + 'courseid' => $courseid, + 'userid' => $user->id, + 'userfullname' => fullname($user), + 'maxdepth' => $report->maxdepth, + 'tabledata' => $report->tabledata + ); + + } else { + $defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol); + $showonlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol); + $showonlyactiveenrol = $showonlyactiveenrol || !has_capability('moodle/course:viewsuspendedusers', $context); + + $gui = new graded_users_iterator($course); + $gui->require_active_enrolment($showonlyactiveenrol); + $gui->init(); + + while ($userdata = $gui->next_user()) { + $currentuser = $userdata->user; + $report = new grade_report_user($courseid, $gpr, $context, $currentuser->id); + $report->fill_table(); + + $tables[] = array( + 'courseid' => $courseid, + 'userid' => $currentuser->id, + 'userfullname' => fullname($currentuser), + 'maxdepth' => $report->maxdepth, + 'tabledata' => $report->tabledata + ); + } + $gui->close(); + } + + $result = array(); + $result['tables'] = $tables; + $result['warnings'] = $warnings; + return $result; + } + + /** + * Creates a table column structure + * + * @return array + * @since Moodle 2.9 + */ + private static function grades_table_column() { + return array ( + 'class' => new external_value(PARAM_RAW, 'class'), + 'content' => new external_value(PARAM_RAW, 'cell content'), + 'headers' => new external_value(PARAM_RAW, 'headers') + ); + } + + /** + * Describes tget_grades_table return value. + * + * @return external_single_structure + * @since Moodle 2.9 + */ + public static function get_grades_table_returns() { + return new external_single_structure( + array( + 'tables' => new external_multiple_structure( + new external_single_structure( + array( + 'courseid' => new external_value(PARAM_INT, 'course id'), + 'userid' => new external_value(PARAM_INT, 'user id'), + 'userfullname' => new external_value(PARAM_TEXT, 'user fullname'), + 'maxdepth' => new external_value(PARAM_INT, 'table max depth (needed for printing it)'), + 'tabledata' => new external_multiple_structure( + new external_single_structure( + array( + 'itemname' => new external_single_structure( + array ( + 'class' => new external_value(PARAM_RAW, 'class'), + 'colspan' => new external_value(PARAM_INT, 'col span'), + 'content' => new external_value(PARAM_RAW, 'cell content'), + 'celltype' => new external_value(PARAM_RAW, 'cell type'), + 'id' => new external_value(PARAM_ALPHANUMEXT, 'id') + ), 'The item returned data', VALUE_OPTIONAL + ), + 'leader' => new external_single_structure( + array ( + 'class' => new external_value(PARAM_RAW, 'class'), + 'rowspan' => new external_value(PARAM_INT, 'row span') + ), 'The item returned data', VALUE_OPTIONAL + ), + 'weight' => new external_single_structure( + self::grades_table_column(), 'weight column', VALUE_OPTIONAL + ), + 'grade' => new external_single_structure( + self::grades_table_column(), 'grade column', VALUE_OPTIONAL + ), + 'range' => new external_single_structure( + self::grades_table_column(), 'range column', VALUE_OPTIONAL + ), + 'percentage' => new external_single_structure( + self::grades_table_column(), 'percentage column', VALUE_OPTIONAL + ), + 'lettergrade' => new external_single_structure( + self::grades_table_column(), 'lettergrade column', VALUE_OPTIONAL + ), + 'rank' => new external_single_structure( + self::grades_table_column(), 'rank column', VALUE_OPTIONAL + ), + 'average' => new external_single_structure( + self::grades_table_column(), 'average column', VALUE_OPTIONAL + ), + 'feedback' => new external_single_structure( + self::grades_table_column(), 'feedback column', VALUE_OPTIONAL + ), + 'contributiontocoursetotal' => new external_single_structure( + self::grades_table_column(), 'contributiontocoursetotal column', VALUE_OPTIONAL + ), + ), 'table' + ) + ) + ) + ) + ), + 'warnings' => new external_warnings() + ) + ); + } +} diff --git a/lib/db/services.php b/lib/db/services.php index 84bf5f02955..155401ad796 100644 --- a/lib/db/services.php +++ b/lib/db/services.php @@ -984,7 +984,8 @@ $services = array( 'core_message_unblock_contacts', 'core_message_get_contacts', 'core_message_search_contacts', - 'core_message_get_blocked_users' + 'core_message_get_blocked_users', + 'gradereport_user_get_grades_table' ), 'enabled' => 0, 'restrictedusers' => 0, -- 2.17.1