MDL-68334 user: Display name in footer as elsewhere.
[moodle.git] / blocks / recentlyaccesseditems / classes / external / recentlyaccesseditems_item_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/>.
16 /**
17  * Class for exporting the data needed to render a recent accessed item.
18  *
19  * @package    block_recentlyaccesseditems
20  * @copyright  2018 Victor Deniz <victor@moodle.com>
21  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
22  */
23 namespace block_recentlyaccesseditems\external;
24 defined('MOODLE_INTERNAL') || die();
26 use renderer_base;
27 use moodle_url;
29 /**
30  * Class for exporting the data needed to render a recent accessed item.
31  *
32  * @copyright  2018 Victor Deniz
33  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
34  */
35 class recentlyaccesseditems_item_exporter extends \core\external\exporter {
36     /**
37      * Returns a list of objects that are related to this persistent.
38      *
39      */
40     protected static function define_related() {
41         // We cache the context so it does not need to be retrieved from the course.
42         return array('context' => '\\context');
43     }
45     /**
46      * Get the additional values to inject while exporting.
47      *
48      * @param renderer_base $output The renderer
49      * @return array Additional properties with values
50      */
51     protected function get_other_values(renderer_base $output) {
52         global $OUTPUT;
54         return array(
55                 'viewurl' => (new moodle_url('/mod/'.$this->data->modname.'/view.php',
56                         array('id' => $this->data->cmid)))->out(false),
57                 'courseviewurl' => (new moodle_url('/course/view.php', array('id' => $this->data->courseid)))->out(false),
58                 'icon' => $OUTPUT->image_icon('icon', get_string('pluginname', $this->data->modname), $this->data->modname)
59         );
60     }
62     /**
63      * Return the list of properties.
64      *
65      * @return array Properties.
66      */
67     public static function define_properties() {
68         return array(
69             'id' => array(
70                 'type' => PARAM_INT,
71             ),
72             'courseid' => array(
73                 'type' => PARAM_INT,
74             ),
75             'cmid' => array(
76                 'type' => PARAM_INT,
77             ),
78             'userid' => array(
79                 'type' => PARAM_INT,
80             ),
81             'modname' => array(
82                 'type' => PARAM_TEXT,
83             ),
84             'name' => array(
85                     'type' => PARAM_TEXT,
86             ),
87             'coursename' => array(
88                 'type' => PARAM_TEXT,
89             ),
90             'timeaccess' => array(
91                 'type' => PARAM_INT,
92             )
93         );
94     }
96     /**
97      * Return the list of additional properties.
98      *
99      * @return array Additional properties.
100      */
101     public static function define_other_properties() {
102         return array(
103             'viewurl' => array(
104                 'type' => PARAM_TEXT,
105             ),
106             'courseviewurl' => array(
107                     'type' => PARAM_URL,
108             ),
109             'icon' => array(
110                 'type' => PARAM_RAW,
111             )
112         );
113     }