9c491d1c4a5507d921b683a402301d2a1b36f5c3
[moodle.git] / admin / tool / lp / classes / external / template_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 template 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 moodle_url;
28 use renderer_base;
29 use tool_lp\plan;
30 use tool_lp\template_cohort;
32 /**
33  * Class for exporting template data.
34  *
35  * @copyright  2015 Damyon Wiese
36  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37  */
38 class template_exporter extends persistent_exporter {
40     protected static function define_class() {
41         return 'tool_lp\\template';
42     }
44     protected function get_other_values(renderer_base $output) {
45         return array(
46             'duedateformatted' => userdate($this->persistent->get_duedate()),
47             'cohortscount' => template_cohort::count_records(array('templateid' => $this->persistent->get_id())),
48             'planscount' => plan::count_records(array('templateid' => $this->persistent->get_id())),
49             'canmanage' => $this->persistent->can_manage(),
50             'canread' => $this->persistent->can_read(),
51             'contextname' => $this->persistent->get_context()->get_context_name()
52         );
53     }
55     protected static function define_other_properties() {
56         return array(
57             'duedateformatted' => array(
58                 'type' => PARAM_RAW
59             ),
60             'cohortscount' => array(
61                 'type' => PARAM_INT
62             ),
63             'planscount' => array(
64                 'type' => PARAM_INT
65             ),
66             'canmanage' => array(
67                 'type' => PARAM_BOOL
68             ),
69             'canread' => array(
70                 'type' => PARAM_BOOL
71             ),
72             'contextname' => array(
73                 'type' => PARAM_TEXT,
74             )
75         );
76     }
77 }