2b602e305619f46c731adba6e3156a76fbb8e841
[moodle.git] / admin / tool / lp / classes / external / competency_framework_exporter.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 for exporting competency_framework data.
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\external;
25 defined('MOODLE_INTERNAL') || die();
27 use tool_lp\api;
28 use renderer_base;
30 /**
31  * Class for exporting competency_framework data.
32  *
33  * @copyright  2015 Damyon Wiese
34  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
35  */
36 class competency_framework_exporter extends persistent_exporter {
38     /**
39      * Define the name of persistent class.
40      *
41      * @return string
42      */
43     protected static function define_class() {
44         return 'tool_lp\\competency_framework';
45     }
47     /**
48      * Get other values that do not belong to the basic persisent.
49      *
50      * @param renderer_base $output
51      * @return Array
52      */
53     protected function get_other_values(renderer_base $output) {
54         $filters = array('competencyframeworkid' => $this->persistent->get_id());
55         return array(
56             'canmanage' => has_capability('tool/lp:competencymanage', $this->persistent->get_context()),
57             'competenciescount' => api::count_competencies($filters),
58             'contextname' => $this->persistent->get_context()->get_context_name()
59         );
60     }
62     /**
63      * Define other properties that do not belong to the basic persisent.
64      *
65      * @return Array
66      */
67     protected static function define_other_properties() {
68         return array(
69             'canmanage' => array(
70                 'type' => PARAM_BOOL
71             ),
72             'competenciescount' => array(
73                 'type' => PARAM_INT
74             ),
75             'contextname' => array(
76                 'type' => PARAM_TEXT
77             )
78         );
79     }
81 }