moodle/moodle
3
0
Fork 0
mirror of https://github.com/moodle/moodle.git synced 2025-08-06 17:36:38 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

MDL-52916 cbe: Refactor competency breakdown report

Browse source 
Redesign this to fit when there are unlimited competencies / users.
This commit is contained in:
Damyon Wiese 2016-01-28 16:03:41 +08:00 • committed by Frederic Massart
parent 47cddb9c1f
commit 21e0dd61e5
12 changed files with 357 additions and 116 deletions
Download patch file Download diff file Expand all files Collapse all files

28
report/competency/classes/external.php
View file

@ -33,7 +33,7 @@ use external_function_parameters;
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;
@ -57,6 +57,11 @@ class external extends external_api {
'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',
@ -69,6 +74,7 @@ class external extends external_api {
);
$params = array(
'courseid' => $courseid,
'userid' => $userid,
'groupid' => $groupid,
'onlyactive' => $onlyactive,
);
@ -83,21 +89,25 @@ class external extends external_api {
* @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);
@ -115,17 +125,13 @@ class external extends external_api {
'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()
))
)
));

10
report/competency/classes/output/renderer.php
View file

@ -50,4 +50,14 @@ class renderer extends plugin_renderer_base {
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);
}
}

110
report/competency/classes/output/report.php
View file

@ -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;
@ -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);
}
/**
@ -93,20 +88,6 @@ class report implements renderable, templatable {
$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));
@ -116,44 +97,55 @@ class report implements renderable, templatable {
$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();
}
$scale = $scalecache[$competency->get_scaleid()];
$exporter = new user_competency_exporter($usercompetency, array('scale' => $scale));
$record = $exporter->export($output);
array_push($onerow->usercompetencies, $record);
}
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();
}
} 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);
}

113
report/competency/classes/output/user_course_navigation.php Normal file
View file

@ -0,0 +1,113 @@
<?php
// 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/>.
/**
* User navigation class.
*
* @package report_competency
* @copyright 2015 Damyon Wiese
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
namespace report_competency\output;
use renderable;
use renderer_base;
use templatable;
use context_course;
use \tool_lp\external\user_summary_exporter;
use stdClass;
/**
* User course navigation class.
*
* @package tool_lp
* @copyright 2015 Damyon Wiese
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
*/
class user_course_navigation implements renderable, templatable {
/** @var userid */
protected $userid;
/** @var courseid */
protected $courseid;
/** @var baseurl */
protected $baseurl;
/**
* Construct.
*
* @param $userid
* @param $courseid
* @param $baseurl
*/
public function __construct($userid, $courseid, $baseurl) {
$this->userid = $userid;
$this->courseid = $courseid;
$this->baseurl = $baseurl;
}
/**
* Export the data.
*
* @param renderer_base $output
* @return stdClass
*/
public function export_for_template(renderer_base $output) {
global $CFG, $DB, $SESSION, $PAGE;
$context = context_course::instance($this->courseid);
$data = new stdClass();
$data->userid = $this->userid;
$data->courseid = $this->courseid;
$data->baseurl = $this->baseurl;
if (has_capability('tool/lp:coursecompetencymanage', $context)) {
$course = $DB->get_record('course', array('id' => $this->courseid));
$currentgroup = optional_param('group', null, PARAM_INT);
$select = groups_allgroups_course_menu($course, $PAGE->url, true, $currentgroup);
// Fetch showactive.
$defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol);
$showonlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol);
$showonlyactiveenrol = $showonlyactiveenrol || !has_capability('moodle/course:viewsuspendedusers', $context);
// Fetch current active group.
$groupmode = groups_get_course_groupmode($course);
$currentgroup = $SESSION->activegroup[$course->id][$groupmode][$course->defaultgroupingid];
$users = get_enrolled_users($context, 'tool/lp:coursecompetencygradable', $currentgroup,
'u.*', null, 0, 0, $showonlyactiveenrol);
$data->users = array();
foreach ($users as $user) {
$exporter = new user_summary_exporter($user);
$user = $exporter->export($output);
if ($user->id == $this->userid) {
$user->selected = true;
}
$data->users[] = $user;
}
$data->hasusers = true;
} else {
$data->users = array();
$data->hasusers = false;
}
return $data;
}
}