e468a7ce24826eacf6480951c4871263885d089e
[moodle.git] / course / classes / local / exporters / course_content_items_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  * Contains the course_content_items_exporter class.
19  *
20  * @package    core
21  * @subpackage course
22  * @copyright  2020 Jake Dallimore <jrhdallimore@gmail.com>
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
25 namespace core_course\local\exporters;
27 defined('MOODLE_INTERNAL') || die();
29 use core\external\exporter;
30 use core_course\local\entity\content_item;
32 /**
33  * The course_content_items_exporter class.
34  *
35  * @copyright  2020 Jake Dallimore <jrhdallimore@gmail.com>
36  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
37  */
38 class course_content_items_exporter extends exporter {
40     /** @var content_item[] the array of content items. */
41     private $contentitems;
43     /**
44      * The course_content_items_exporter constructor.
45      *
46      * @param array $contentitems the array of \core_course\local\entity\content_item objects to export.
47      * @param array $related any related objects, see define_related for what's expected.
48      */
49     public function __construct(array $contentitems, array $related) {
50         $this->contentitems = $contentitems;
52         parent::__construct([], $related);
53     }
55     /**
56      * Return the properties defining this export.
57      *
58      * @return array the array of properties.
59      */
60     public static function define_properties() {
61         return [
62             'content_items' => [
63                 'type' => course_content_item_exporter::read_properties_definition(),
64                 'multiple' => true
65             ]
66         ];
67     }
69     /**
70      * Generate and return the data for this export.
71      *
72      * @param \renderer_base $output
73      * @return array the array of course content_items
74      */
75     protected function get_other_values(\renderer_base $output) {
77         $contentitemexport = function(content_item $contentitem) use ($output) {
78             $exporter = new course_content_item_exporter(
79                 $contentitem,
80                 [
81                     'context' => $this->related['context'],
82                     'favouriteitems' => $this->related['favouriteitems'],
83                 ]
84             );
85             return $exporter->export($output);
86         };
88         $exportedcontentitems = array_map($contentitemexport, $this->contentitems);
90         return [
91             'content_items' => $exportedcontentitems
92         ];
93     }
95     /**
96      * Define the list of related objects, used by this exporter.
97      *
98      * @return array the list of related objects.
99      */
100     protected static function define_related() {
101         return [
102             'context' => '\context',
103             'favouriteitems' => '\stdClass[]?'
104         ];
105     }