MDL-51043 cbe: Competency breakdown report

admin/tool/lp/classes/api.php

@@ -740,6 +740,33 @@ public static function list_course_competencies($courseorid) {
         return $result;
     }
 
+    /**
+     * List all the user competencies in a course.
+     *
+     * @param int $courseid The id of the course to check.
+     * @param int $userid The id of the course to check.
+     * @return array of competencies
+     */
+    public static function list_user_competencies_in_course($courseid, $userid) {
+        // First we do a permissions check.
+        $context = context_course::instance($courseid);
+        $onlyvisible = 1;
+
+        $capabilities = array('tool/lp:coursecompetencyread', 'tool/lp:coursecompetencymanage');
+        if (!has_any_capability($capabilities, $context)) {
+             throw new required_capability_exception($context, 'tool/lp:coursecompetencyread', 'nopermissions', '');
+        }
+
+        if (has_capability('tool/lp:coursecompetencymanage', $context)) {
+            $onlyvisible = 0;
+        }
+
+        // OK - all set.
+        $competencylist = course_competency::list_competencies($courseid, $onlyvisible);
+
+        return user_competency::get_multiple($userid, $competencylist);
+    }
+
     /**
      * Add a competency to this course.
      *

admin/tool/lp/db/access.php

@@ -52,6 +52,14 @@
         ),
         'clonepermissionsfrom' => 'moodle/site:backup'
     ),
+    'tool/lp:coursecompetencygradable' => array(
+        'captype' => 'read',
+        'contextlevel' => CONTEXT_COURSE,
+        'archetypes' => array(
+            'student' => CAP_ALLOW
+        ),
+        'clonepermissionsfrom' => 'moodle/course:isincompletionreports'
+    ),
     'tool/lp:coursecompetencyread' => array(
         'captype' => 'read',
         'contextlevel' => CONTEXT_COURSE,

report/competency/classes/output/renderer.php

@@ -0,0 +1,53 @@
+<?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/>.
+
+/**
+ * Renderer class for report_competency
+ *
+ * @package    report_competency
+ * @copyright  2015 Damyon Wiese
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace report_competency\output;
+
+defined('MOODLE_INTERNAL') || die;
+
+use plugin_renderer_base;
+use renderable;
+
+/**
+ * Renderer class for competency breakdown report
+ *
+ * @package    report_competency
+ * @copyright  2015 Damyon Wiese
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class renderer extends plugin_renderer_base {
+
+    /**
+     * Defer to template.
+     *
+     * @param report $report
+     *
+     * @return string html for the page
+     */
+    public function render_report(report $page) {
+        $data = $page->export_for_template($this);
+        return parent::render_from_template('report_competency/report', $data);
+    }
+
+}

report/competency/classes/output/report.php

@@ -0,0 +1,120 @@
+<?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/>.
+
+/**
+ * Class containing data for learning plan template competencies page
+ *
+ * @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 context_course;
+use tool_lp\external\competency_exporter;
+use tool_lp\external\user_competency_exporter;
+use tool_lp\external\user_summary_exporter;
+use tool_lp\user_competency;
+use renderable;
+use templatable;
+use renderer_base;
+use stdClass;
+use tool_lp\api;
+
+/**
+ * Class containing data for learning plan template competencies page
+ *
+ * @copyright  2015 Damyon Wiese
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+class report implements renderable, templatable {
+
+    /** @var context $context */
+    protected $context;
+
+    /**
+     * Construct this renderable.
+     *
+     * @param int $courseid The course id
+     * @param int $groupid The group id
+     * @param bool $onlyactive Only show active (not suspended) students.
+     */
+    public function __construct($courseid, $groupid, $onlyactive) {
+        $this->courseid = $courseid;
+        $this->context = context_course::instance($courseid);
+        // Get all the competencies in this course.
+        $this->competencies = api::list_competencies_in_course($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);
+
+    }
+
+    /**
+     * Export this data so it can be used as the context for a mustache template.
+     *
+     * @param \renderer_base $output
+     * @return stdClass
+     */
+    public function export_for_template(renderer_base $output) {
+        $data = new stdClass();
+        $competencies = array();
+        $contextcache = array();
+        foreach ($this->competencies as $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;
+
+        $data->usercompetencies = array();
+        $scalecache = array();
+        foreach ($this->users as $user) {
+            $usercompetencies = api::list_user_competencies_in_course($this->courseid, $user->id);
+            $onerow = new stdClass();
+            $exporter = new user_summary_exporter($user);
+            $onerow->user = $exporter->export($output);
+            $onerow->usercompetencies = array();
+
+            foreach ($this->competencies as $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;
+                    }
+                }
+                if (!isset($scalecache[$competency->get_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);
+            }
+            array_push($data->usercompetencies, $onerow);
+        }
+
+        return $data;
+    }
+}

report/competency/index.php

@@ -0,0 +1,71 @@
+<?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/>.
+
+/**
+ * This page lets users to manage site wide competencies.
+ *
+ * @package    tool_lp
+ * @copyright  2015 Damyon Wiese
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+require_once(__DIR__ . '/../../config.php');
+
+$id = required_param('id', PARAM_INT);
+
+$params = array('id' => $id);
+$course = $DB->get_record('course', $params, '*', MUST_EXIST);
+require_login($course);
+$context = context_course::instance($course->id);
+$currentgroup = optional_param('group', null, PARAM_INT);
+$urlparams = array('id' => $id, 'group' => $currentgroup);
+
+$url = new moodle_url('/report/competency/index.php', $urlparams);
+$title = get_string('pluginname', 'report_competency');
+$PAGE->set_url($url);
+$PAGE->set_title($title);
+$coursename = format_text($course->fullname, false, array('context' => $context));
+$PAGE->set_heading($coursename);
+$PAGE->set_pagelayout('incourse');
+
+$output = $PAGE->get_renderer('report_competency');
+echo $output->header();
+echo $output->heading($title);
+
+$select = groups_allgroups_course_menu($course, $url, true, $currentgroup);
+
+// User cannot see any group.
+if (empty($select)) {
+    echo $OUTPUT->heading(get_string("notingroup"));
+    echo $OUTPUT->footer();
+    exit;
+} else {
+    echo $select;
+}
+
+// Fetch current active group.
+$groupmode = groups_get_course_groupmode($course);
+$currentgroup = $SESSION->activegroup[$course->id][$groupmode][$course->defaultgroupingid];
+
+// Will exclude suspended users if required.
+$defaultgradeshowactiveenrol = !empty($CFG->grade_report_showonlyactiveenrol);
+$showonlyactiveenrol = get_user_preferences('grade_report_showonlyactiveenrol', $defaultgradeshowactiveenrol);
+$showonlyactiveenrol = $showonlyactiveenrol || !has_capability('moodle/course:viewsuspendedusers', $context);
+
+$page = new \report_competency\output\report($course->id, $currentgroup, $showonlyactiveenrol);
+echo $output->render($page);
+
+echo $output->footer();

report/competency/lang/en/report_competency.php

@@ -0,0 +1,26 @@
+<?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/>.
+
+/**
+ * Strings for component 'report_competency', language 'en'
+ *
+ * @package    report_competency
+ * @copyright  2015 Damyon Wiese
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+$string['pluginname'] = 'Competency breakdown';
+$string['coursecompetencybreakdownsummary'] = 'A report of all the students in the course, and their progress towards the course competencies';

report/competency/lib.php

@@ -0,0 +1,42 @@
+<?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/>.
+
+/**
+ * Public API of the competency report.
+ *
+ * Defines the APIs used by competency reports
+ *
+ * @package    report_competency
+ * @copyright  2015 Damyon Wiese
+ * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+defined('MOODLE_INTERNAL') || die;
+
+/**
+ * This function extends the navigation with the report items
+ *
+ * @param navigation_node $navigation The navigation node to extend
+ * @param stdClass $course The course to object for the report
+ * @param stdClass $context The context of the course
+ */
+function report_competency_extend_navigation_course($navigation, $course, $context) {
+    if (has_capability('tool/lp:coursecompetencyread', $context)) {
+        $url = new moodle_url('/report/competency/index.php', array('id'=>$course->id));
+        $name = get_string('pluginname', 'report_competency');
+        $navigation->add($name, $url, navigation_node::TYPE_SETTING, null, null, new pix_icon('i/report', ''));
+    }
+}

report/competency/templates/report.mustache

@@ -0,0 +1,25 @@
+<table class="table table-bordered">
+<caption>{{#str}}coursecompetencybreakdownsummary, report_competency{{/str}}</caption>
+<tr>
+<td scope="col"><span class="accesshide">{{#str}}students{{/str}}</span></td>
+{{#competencies}}
+    <th scope="col">
+    {{> tool_lp/competency_summary }}
+    </th>
+{{/competencies}}
+</tr>
+{{#usercompetencies}}
+<tr>
+<th scope="row">
+{{#user}}
+{{> tool_lp/form-user-selector-suggestion }}
+{{/user}}
+</th>
+{{#usercompetencies}}
+<td class="alert {{#proficiency}}alert-success{{/proficiency}}">
+{{> report_competency/user_competency_summary}}
+</td>
+{{/usercompetencies}}
+</tr>
+{{/usercompetencies}}
+</table>

report/competency/templates/user_competency_summary.mustache

@@ -0,0 +1 @@
+{{gradename}}