2c5dbabc18d0c42853c5543a8a71f8589feaf7ef
[moodle.git] / admin / tool / lp / classes / output / template_competencies_page.php
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/>.
17 /**
18  * Class containing data for learning plan template competencies page
19  *
20  * @package    tool_lp
21  * @copyright  2015 Damyon Wiese
22  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
24 namespace tool_lp\output;
25 defined('MOODLE_INTERNAL') || die();
27 use renderable;
28 use templatable;
29 use renderer_base;
30 use stdClass;
31 use context;
32 use context_system;
33 use moodle_url;
34 use tool_lp\api;
35 use tool_lp\external\competency_summary_exporter;
36 use tool_lp\template_statistics;
37 use tool_lp\external\template_statistics_exporter;
39 /**
40  * Class containing data for learning plan template competencies page
41  *
42  * @copyright  2015 Damyon Wiese
43  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
44  */
45 class template_competencies_page implements renderable, templatable {
47     /** @var int $templateid Template id for this page. */
48     protected $templateid = null;
50     /** @var \tool_lp\competency[] $competencies List of competencies. */
51     protected $competencies = array();
53     /** @var bool $canmanagecompetencyframeworks Can the current user manage competency frameworks. */
54     protected $canmanagecompetencyframeworks = false;
56     /** @var bool $canmanagecoursecompetencies Can the current user manage course competency frameworks.. */
57     protected $canmanagecoursecompetencies = false;
59     /** @var string $manageurl manage url. */
60     protected $manageurl = null;
62     /** @var context $pagecontext The page context. */
63     protected $pagecontext = null;
65     /** @var template_statistics $templatestatistics The generated summary statistics for this template. */
66     protected $templatestatistics = null;
68     /**
69      * Construct this renderable.
70      *
71      * @param int $templateid The learning plan template id for this page.
72      * @param context $pagecontext The page context.
73      */
74     public function __construct($templateid, context $pagecontext) {
75         $this->pagecontext = $pagecontext;
76         $this->templateid = $templateid;
77         $this->templatestatistics = new template_statistics($templateid);
78         $this->competencies = api::list_competencies_in_template($templateid);
79         $this->canmanagecompetencyframeworks = has_capability('tool/lp:competencymanage', $this->pagecontext);
80         $this->canmanagetemplatecompetencies = has_capability('tool/lp:templatemanage', $this->pagecontext);
81         $this->manageurl = new moodle_url('/admin/tool/lp/competencyframeworks.php',
82             array('pagecontextid' => $this->pagecontext->id));
83     }
85     /**
86      * Export this data so it can be used as the context for a mustache template.
87      *
88      * @param \renderer_base $output
89      * @return stdClass
90      */
91     public function export_for_template(renderer_base $output) {
92         $data = new stdClass();
93         $data->pagecontextid = $this->pagecontext->id;
94         $data->templateid = $this->templateid;
95         $data->competencies = array();
96         $contextcache = array();
97         $frameworkcache = array();
98         foreach ($this->competencies as $competency) {
99             if (!isset($contextcache[$competency->get_competencyframeworkid()])) {
100                 $contextcache[$competency->get_competencyframeworkid()] = $competency->get_context();
101             }
102             $context = $contextcache[$competency->get_competencyframeworkid()];
103             if (!isset($frameworkcache[$competency->get_competencyframeworkid()])) {
104                 $frameworkcache[$competency->get_competencyframeworkid()] = $competency->get_framework();
105             }
106             $framework = $frameworkcache[$competency->get_competencyframeworkid()];
108             $courses = api::list_courses_using_competency($competency->get_id());
109             $relatedcompetencies = api::list_related_competencies($competency->get_id());
111             $related = array(
112                 'competency' => $competency,
113                 'linkedcourses' => $courses,
114                 'context' => $context,
115                 'relatedcompetencies' => $relatedcompetencies,
116                 'framework' => $framework
117             );
118             $exporter = new competency_summary_exporter(null, $related);
119             $record = $exporter->export($output);
121             array_push($data->competencies, $record);
122         }
123         $data->canmanagecompetencyframeworks = $this->canmanagecompetencyframeworks;
124         $data->canmanagetemplatecompetencies = $this->canmanagetemplatecompetencies;
125         $data->manageurl = $this->manageurl->out(true);
126         $exporter = new template_statistics_exporter($this->templatestatistics);
127         $data->statistics = $exporter->export($output);
128         $data->showcompetencylinks = true;
130         return $data;
131     }