Skip to content

Commit

Permalink
MDL-52916 cbe: Refactor competency breakdown report
Browse files Browse the repository at this point in the history 
Redesign this to fit when there are unlimited competencies / users.
  • Loading branch information
Damyon Wiese authored and Frederic Massart committed Apr 18, 2016
1 parent 47cddb9 commit 21e0dd6
Show file tree
Hide file tree
Showing 12 changed files with 343 additions and 102 deletions.
2 changes: 1 addition & 1 deletion report/competency/amd/build/grading_popup.min.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

1 change: 1 addition & 0 deletions report/competency/amd/build/user_course_navigation.min.js
View file

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion report/competency/amd/src/grading_popup.js
View file
Expand Up @@ -83,11 +83,12 @@ define(['jquery', 'core/notification', 'core/str', 'core/ajax', 'core/log', 'cor
var region = $(this._regionSelector);
var courseId = region.data('courseid');
var groupId = region.data('groupid');
var userId = region.data('userid');
var onlyActive = region.data('onlyactive');

ajax.call([{
methodname : 'report_competency_data_for_report',
args: { courseid: courseId, groupid: groupId, onlyactive: onlyActive },
args: { courseid: courseId, groupid: groupId, userid: userId, onlyactive: onlyActive },
done: this._pageContextLoaded.bind(this),
fail: notification.exception
}]);
Expand Down
71 changes: 71 additions & 0 deletions report/competency/amd/src/user_course_navigation.js
View file
@@ -0,0 +1,71 @@
// This file is part of 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/>.

/**
* Module to navigation between users in a course.
*
* @package report_competency
* @copyright 2015 Damyon Wiese
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/

define(['jquery'], function($) {

/**
* UserCourseNavigation
*
* @param {String} The selector of the user element.
* @param {String} The base url for the page (no params).
* @param {Number} The course id
* @param {Number} The user id
*/
var UserCourseNavigation = function(userSelector, baseUrl, userId, courseId) {
this._baseUrl = baseUrl;
this._userId = userId + '';
this._courseId = courseId;
this._ignoreFirstUser = true;

$(userSelector).on('change', this._userChanged.bind(this));
};

/**
* The user was changed in the select list.
*
* @method _userChanged
* @param {Event} e
*/
UserCourseNavigation.prototype._userChanged = function(e) {
if (this._ignoreFirstUser) {
this._ignoreFirstUser = false;
return;
}

var newUserId = $(e.target).val();
var queryStr = '?user=' + newUserId + '&id=' + this._courseId;
document.location = this._baseUrl + queryStr;
};

/** @type {Number} The id of the user. */
UserCourseNavigation.prototype._userId = null;
/** @type {Number} The id of the course. */
UserCourseNavigation.prototype._courseId = null;
/** @type {String} Plugin base url. */
UserCourseNavigation.prototype._baseUrl = null;
/** @type {Boolean} Ignore the first change event for users. */
UserCourseNavigation.prototype._ignoreFirstUser = null;

return /** @alias module:report_competency/user_course_navigation */ UserCourseNavigation;

});
28 changes: 17 additions & 11 deletions report/competency/classes/external.php
View file
Expand Up @@ -33,7 +33,7 @@
use external_multiple_structure;
use external_single_structure;
use external_value;
use tool_lp\external\competency_exporter;
use tool_lp\external\competency_summary_exporter;
use tool_lp\external\course_summary_exporter;
use tool_lp\external\user_competency_exporter;
use tool_lp\external\user_summary_exporter;
Expand All @@ -57,6 +57,11 @@ public static function data_for_report_parameters() {
'The course id',
VALUE_REQUIRED
);
$userid = new external_value(
PARAM_INT,
'The user id',
VALUE_REQUIRED
);
$groupid = new external_value(
PARAM_INT,
'The group id',
Expand All @@ -69,6 +74,7 @@ public static function data_for_report_parameters() {
);
$params = array(
'courseid' => $courseid,
'userid' => $userid,
'groupid' => $groupid,
'onlyactive' => $onlyactive,
);
Expand All @@ -83,21 +89,25 @@ public static function data_for_report_parameters() {
* @param boolean $onlyactive Only show active enrolments
* @return \stdClass
*/
public static function data_for_report($courseid, $groupid, $onlyactive) {
public static function data_for_report($courseid, $userid, $groupid, $onlyactive) {
global $PAGE;

$params = self::validate_parameters(
self::data_for_report_parameters(),
array(
'courseid' => $courseid,
'userid' => $userid,
'groupid' => $groupid,
'onlyactive' => $onlyactive
)
);
$context = context_course::instance($courseid);
$context = context_course::instance($params['courseid']);
self::validate_context($context);
if (!is_enrolled($context, $params['userid'], 'tool/lp:coursecompetencygradable')) {
throw new coding_exception('invaliduser');
}

$renderable = new output\report($params['courseid'], $params['groupid'], $params['onlyactive']);
$renderable = new output\report($params['courseid'], $params['userid'], $params['groupid'], $params['onlyactive']);
$renderer = $PAGE->get_renderer('report_competency');

$data = $renderable->export_for_template($renderer);
Expand All @@ -115,17 +125,13 @@ public static function data_for_report_returns() {
'courseid' => new external_value(PARAM_INT, 'Course id'),
'groupid' => new external_value(PARAM_INT, 'Group id'),
'onlyactive' => new external_value(PARAM_BOOL, 'Only include active enrolments'),
'competencies' => new external_multiple_structure(
competency_exporter::get_read_structure()
),
'user' => user_summary_exporter::get_read_structure(),
'course' => course_summary_exporter::get_read_structure(),
'pluginbaseurl' => new external_value(PARAM_LOCALURL, 'Url to the tool_lp plugin folder on this Moodle site'),
'usercompetencies' => new external_multiple_structure(
new external_single_structure(array(
'user' => user_summary_exporter::get_read_structure(),
'usercompetencies' => new external_multiple_structure(
user_competency_exporter::get_read_structure()
)
'usercompetency' => user_competency_exporter::get_read_structure(),
'competency' => competency_summary_exporter::get_read_structure()
))
)
));
Expand Down
10 changes: 10 additions & 0 deletions report/competency/classes/output/renderer.php
View file
Expand Up @@ -50,4 +50,14 @@ public function render_report(report $page) {
return parent::render_from_template('report_competency/report', $data);
}

/**
* Defer to template.
*
* @param user_course_navigation $nav
* @return string
*/
public function render_user_course_navigation(user_course_navigation $nav) {
$data = $nav->export_for_template($this);
return parent::render_from_template('report_competency/user_course_navigation', $data);
}
}
106 changes: 49 additions & 57 deletions report/competency/classes/output/report.php
View file
Expand Up @@ -24,12 +24,13 @@
namespace report_competency\output;

use context_course;
use tool_lp\external\competency_exporter;
use tool_lp\external\competency_summary_exporter;
use tool_lp\external\course_summary_exporter;
use tool_lp\external\user_competency_exporter;
use tool_lp\external\user_summary_exporter;
use tool_lp\user_competency;
use renderable;
use core_user;
use templatable;
use renderer_base;
use moodle_url;
Expand Down Expand Up @@ -61,22 +62,16 @@ class report implements renderable, templatable {
* Construct this renderable.
*
* @param int $courseid The course id
* @param int $userid The user id
* @param int $groupid The group id
* @param bool $onlyactive Only show active (not suspended) students.
*/
public function __construct($courseid, $groupid, $onlyactive) {
public function __construct($courseid, $userid, $groupid, $onlyactive) {
$this->courseid = $courseid;
$this->groupid = $groupid;
$this->userid = $userid;
$this->onlyactive = $onlyactive;
$this->context = context_course::instance($courseid);
// Get all the competencies in this course.
$this->competencies = api::list_course_competencies($courseid);

// Get all the users in this course.
// tool/lp:coursecompetencygradable
$this->users = get_enrolled_users($this->context, 'tool/lp:coursecompetencygradable', $groupid,
'u.*', null, 0, 0, $onlyactive);

}

/**
Expand All @@ -93,20 +88,6 @@ public function export_for_template(renderer_base $output) {
$data->groupid = $this->groupid;
$data->onlyactive = $this->onlyactive;

$competencies = array();
$contextcache = array();
foreach ($this->competencies as $coursecompetency) {
$competency = $coursecompetency['competency'];
if (!isset($contextcache[$competency->get_competencyframeworkid()])) {
$contextcache[$competency->get_competencyframeworkid()] = $competency->get_context();
}
$context = $contextcache[$competency->get_competencyframeworkid()];
$exporter = new competency_exporter($competency, array('context' => $context));
$record = $exporter->export($output);
array_push($competencies, $record);
}
$data->competencies = $competencies;

$course = $DB->get_record('course', array('id' => $this->courseid));
$coursecontext = context_course::instance($course->id);
$exporter = new course_summary_exporter($course, array('context' => $coursecontext));
Expand All @@ -116,44 +97,55 @@ public function export_for_template(renderer_base $output) {
$data->usercompetencies = array();
$scalecache = array();
$frameworkcache = array();
foreach ($this->users as $user) {
$usercompetencies = api::list_user_competencies_in_course($this->courseid, $user->id);

$user = core_user::get_user($this->userid);

$exporter = new user_summary_exporter($user);
$data->user = $exporter->export($output);
$data->usercompetencies = array();
$coursecompetencies = api::list_course_competencies($this->courseid);
$usercompetencies = api::list_user_competencies_in_course($this->courseid, $user->id);

foreach ($usercompetencies as $usercompetency) {
$onerow = new stdClass();
$exporter = new user_summary_exporter($user);
$onerow->user = $exporter->export($output);
$onerow->usercompetencies = array();

foreach ($this->competencies as $coursecompetency) {
$competency = $coursecompetency['competency'];
$usercompetency = new user_competency(0, (object) array('userid' => $user->id, 'competencyid' => $competency->get_id()));
foreach ($usercompetencies as $uc) {
if ($uc->get_competencyid() == $competency->get_id()) {
$usercompetency = $uc;
break;
}
$competency = null;
foreach ($coursecompetencies as $coursecompetency) {
if ($coursecompetency['competency']->get_id() == $usercompetency->get_competencyid()) {
$competency = $coursecompetency['competency'];
break;
}

// Fetch the scale.
$scaleid = $competency->get_scaleid();
if ($scaleid === null) {
if (!isset($frameworkcache[$competency->get_competencyframeworkid()])) {
$frameworkcache[$competency->get_competencyframeworkid()] = $competency->get_framework();
}
$framework = $frameworkcache[$competency->get_competencyframeworkid()];
$scaleid = $framework->get_scaleid();
if (!isset($scalecache[$scaleid])) {
$scalecache[$competency->get_scaleid()] = $framework->get_scale();
}

} else if (!isset($scalecache[$scaleid])) {
$scalecache[$competency->get_scaleid()] = $competency->get_scale();
}
if (!$competency) {
continue;
}
// Fetch the framework.
if (!isset($frameworkcache[$competency->get_competencyframeworkid()])) {
$frameworkcache[$competency->get_competencyframeworkid()] = $competency->get_framework();
}
$framework = $frameworkcache[$competency->get_competencyframeworkid()];

// Fetch the scale.
$scaleid = $competency->get_scaleid();
if ($scaleid === null) {
$scaleid = $framework->get_scaleid();
if (!isset($scalecache[$scaleid])) {
$scalecache[$competency->get_scaleid()] = $framework->get_scale();
}
$scale = $scalecache[$competency->get_scaleid()];

$exporter = new user_competency_exporter($usercompetency, array('scale' => $scale));
$record = $exporter->export($output);
array_push($onerow->usercompetencies, $record);
} else if (!isset($scalecache[$scaleid])) {
$scalecache[$competency->get_scaleid()] = $competency->get_scale();
}
$scale = $scalecache[$competency->get_scaleid()];

$exporter = new user_competency_exporter($usercompetency, array('scale' => $scale));
$record = $exporter->export($output);
$onerow->usercompetency = $record;
$exporter = new competency_summary_exporter(null, array('competency' => $competency,
'framework' => $framework,
'context' => $framework->get_context(),
'relatedcompetencies' => array(),
'linkedcourses' => array()));
$onerow->competency = $exporter->export($output);
array_push($data->usercompetencies, $onerow);
}

Expand Down

0 comments on commit 21e0dd6

Please sign in to comment.