MDL-68448 mod_h5pactivity: Add new ws get_h5pactivities_by_courses
[moodle.git] / mod / h5pactivity / classes / external / h5pactivity_summary_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 h5p activity data.
19  *
20  * @package    mod_h5pactivity
21  * @since      Moodle 3.9
22  * @copyright  2020 Carlos Escobedo <carlos@moodle.com>
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
25 namespace mod_h5pactivity\external;
27 use core\external\exporter;
28 use renderer_base;
29 use external_util;
30 use external_files;
31 use core_h5p\factory;
32 use core_h5p\api;
34 /**
35  * Class for exporting h5p activity data.
36  *
37  * @copyright  2020 Carlos Escobedo <carlos@moodle.com>
38  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
39  */
40 class h5pactivity_summary_exporter extends exporter {
42     /**
43      * Properties definition.
44      *
45      * @return array
46      */
47     protected static function define_properties() {
49         return [
50             'id' => [
51                 'type' => PARAM_INT,
52                 'description' => 'The primary key of the record.',
53             ],
54             'course' => [
55                 'type' => PARAM_INT,
56                 'description' => 'Course id this h5p activity is part of.',
57             ],
58             'name' => [
59                 'type' => PARAM_TEXT,
60                 'description' => 'The name of the activity module instance.',
61             ],
62             'timecreated' => [
63                 'type' => PARAM_INT,
64                 'description' => 'Timestamp of when the instance was added to the course.',
65                 'optional' => true,
66             ],
67             'timemodified' => [
68                 'type' => PARAM_INT,
69                 'description' => 'Timestamp of when the instance was last modified.',
70                 'optional' => true,
71             ],
72             'intro' => [
73                 'default' => '',
74                 'type' => PARAM_RAW,
75                 'description' => 'H5P activity description.',
76                 'null' => NULL_ALLOWED,
77             ],
78             'introformat' => [
79                 'choices' => [FORMAT_HTML, FORMAT_MOODLE, FORMAT_PLAIN, FORMAT_MARKDOWN],
80                 'type' => PARAM_INT,
81                 'default' => FORMAT_MOODLE,
82                 'description' => 'The format of the intro field.',
83             ],
84             'grade' => [
85                 'type' => PARAM_INT,
86                 'default' => 0,
87                 'description' => 'The maximum grade for submission.',
88                 'optional' => true,
89             ],
90             'displayoptions' => [
91                 'type' => PARAM_INT,
92                 'default' => 0,
93                 'description' => 'H5P Button display options.',
94             ],
95             'enabletracking' => [
96                 'type' => PARAM_INT,
97                 'default' => 1,
98                 'description' => 'Enable xAPI tracking.',
99             ],
100             'grademethod' => [
101                 'type' => PARAM_INT,
102                 'default' => 1,
103                 'description' => 'Which H5P attempt is used for grading.',
104             ],
105             'contenthash' => [
106                 'type' => PARAM_ALPHANUM,
107                 'description' => 'Sha1 hash of file content.',
108                 'optional' => true,
109             ],
110         ];
111     }
113     /**
114      * Related objects definition.
115      *
116      * @return array
117      */
118     protected static function define_related() {
119         return [
120             'context' => 'context',
121             'factory' => 'core_h5p\\factory'
122         ];
123     }
125     /**
126      * Other properties definition.
127      *
128      * @return array
129      */
130     protected static function define_other_properties() {
131         return [
132             'coursemodule' => [
133                 'type' => PARAM_INT
134             ],
135             'introfiles' => [
136                 'type' => external_files::get_properties_for_exporter(),
137                 'multiple' => true
138             ],
139             'package' => [
140                 'type' => external_files::get_properties_for_exporter(),
141                 'multiple' => true
142             ],
143             'deployedfile' => [
144                 'optional' => true,
145                 'description' => 'H5P file deployed.',
146                 'type' => [
147                     'filename' => array(
148                         'type' => PARAM_FILE,
149                         'description' => 'File name.',
150                         'optional' => true,
151                         'null' => NULL_NOT_ALLOWED,
152                     ),
153                     'filepath' => array(
154                         'type' => PARAM_PATH,
155                         'description' => 'File path.',
156                         'optional' => true,
157                         'null' => NULL_NOT_ALLOWED,
158                     ),
159                     'filesize' => array(
160                         'type' => PARAM_INT,
161                         'description' => 'File size.',
162                         'optional' => true,
163                         'null' => NULL_NOT_ALLOWED,
164                     ),
165                     'fileurl' => array(
166                         'type' => PARAM_URL,
167                         'description' => 'Downloadable file url.',
168                         'optional' => true,
169                         'null' => NULL_NOT_ALLOWED,
170                     ),
171                     'timemodified' => array(
172                         'type' => PARAM_INT,
173                         'description' => 'Time modified.',
174                         'optional' => true,
175                         'null' => NULL_NOT_ALLOWED,
176                     ),
177                     'mimetype' => array(
178                         'type' => PARAM_RAW,
179                         'description' => 'File mime type.',
180                         'optional' => true,
181                         'null' => NULL_NOT_ALLOWED,
182                     )
183                 ]
184             ],
185         ];
186     }
188     /**
189      * Assign values to the defined other properties.
190      *
191      * @param renderer_base $output The output renderer object.
192      * @return array
193      */
194     protected function get_other_values(renderer_base $output) {
195         $context = $this->related['context'];
196         $factory = $this->related['factory'];
198         $values = [
199             'coursemodule' => $context->instanceid,
200         ];
202         $values['introfiles'] = external_util::get_area_files($context->id, 'mod_h5pactivity', 'intro', false, false);
204         $values['package'] = external_util::get_area_files($context->id, 'mod_h5pactivity', 'package', false, false);
206         // Only if this H5P activity has been deployed, return the exported file.
207         $fileh5p = api::get_export_info_from_context_id($context->id, $factory, 'mod_h5pactivity', 'package');
208         if ($fileh5p) {
209             $values['deployedfile'] = $fileh5p;
210         }
212         return $values;
213     }
215     /**
216      * Get the formatting parameters for the intro.
217      *
218      * @return array with the formatting parameters
219      */
220     protected function get_format_parameters_for_intro() {
221         return [
222             'component' => 'mod_h5pactivity',
223             'filearea' => 'intro',
224             'options' => ['noclean' => true],
225         ];
226     }
228     /**
229      * Get the formatting parameters for the package.
230      *
231      * @return array with the formatting parameters
232      */
233     protected function get_format_parameters_for_package() {
234         return [
235             'component' => 'mod_h5pactivity',
236             'filearea' => 'package',
237             'itemid' => 0,
238             'options' => ['noclean' => true],
239         ];
240     }