cc0818097b65b5af24ce0b3ecbde1c9784facd70
[moodle.git] / blocks / classes / external.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  * Blocks external API
19  *
20  * @package    core_block
21  * @category   external
22  * @copyright  2017 Juan Leyva <juan@moodle.com>
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  * @since      Moodle 3.3
25  */
27 defined('MOODLE_INTERNAL') || die;
29 require_once("$CFG->libdir/externallib.php");
31 /**
32  * Blocks external functions
33  *
34  * @package    core_block
35  * @category   external
36  * @copyright  2015 Juan Leyva <juan@moodle.com>
37  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
38  * @since      Moodle 3.3
39  */
40 class core_block_external extends external_api {
43     /**
44      * Returns a block structure.
45      *
46      * @return external_single_structure a block single structure.
47      * @since  Moodle 3.6
48      */
49     private static function get_block_structure() {
50         return new external_single_structure(
51             array(
52                 'instanceid'    => new external_value(PARAM_INT, 'Block instance id.'),
53                 'name'          => new external_value(PARAM_PLUGIN, 'Block name.'),
54                 'region'        => new external_value(PARAM_ALPHANUMEXT, 'Block region.'),
55                 'positionid'    => new external_value(PARAM_INT, 'Position id.'),
56                 'collapsible'   => new external_value(PARAM_BOOL, 'Whether the block is collapsible.'),
57                 'dockable'      => new external_value(PARAM_BOOL, 'Whether the block is dockable.'),
58                 'weight'        => new external_value(PARAM_INT, 'Used to order blocks within a region.', VALUE_OPTIONAL),
59                 'visible'       => new external_value(PARAM_BOOL, 'Whether the block is visible.', VALUE_OPTIONAL),
60                 'contents'      => new external_single_structure(
61                     array(
62                         'title'         => new external_value(PARAM_RAW, 'Block title.'),
63                         'content'       => new external_value(PARAM_RAW, 'Block contents.'),
64                         'contentformat' => new external_format_value('content'),
65                         'footer'        => new external_value(PARAM_RAW, 'Block footer.'),
66                         'files'         => new external_files('Block files.'),
67                     ),
68                     'Block contents (if required).', VALUE_OPTIONAL
69                 ),
70                 'configs' => new external_multiple_structure(
71                     new external_single_structure(
72                         array(
73                             'name' => new external_value(PARAM_RAW, 'Name.'),
74                             'value' => new external_value(PARAM_RAW, 'JSON encoded representation of the config value.'),
75                             'type' => new external_value(PARAM_ALPHA, 'Type (instance or plugin).'),
76                         )
77                     ),
78                     'Block instance and plugin configuration settings.', VALUE_OPTIONAL
79                 ),
80             ), 'Block information.'
81         );
82     }
84     /**
85      * Convenience function for getting all the blocks of the current $PAGE.
86      *
87      * @param bool $includeinvisible Whether to include not visible blocks or not
88      * @param bool $returncontents Whether to return the block contents
89      * @return array Block information
90      * @since  Moodle 3.6
91      */
92     private static function get_all_current_page_blocks($includeinvisible = false, $returncontents = false) {
93         global $PAGE, $OUTPUT;
95         // Load the block instances for all the regions.
96         $PAGE->blocks->load_blocks($includeinvisible);
97         $PAGE->blocks->create_all_block_instances();
99         $allblocks = array();
100         $blocks = $PAGE->blocks->get_content_for_all_regions($OUTPUT);
101         foreach ($blocks as $region => $regionblocks) {
102             $regioninstances = $PAGE->blocks->get_blocks_for_region($region);
103             // Index block instances to retrieve required info.
104             $blockinstances = array();
105             foreach ($regioninstances as $ri) {
106                 $blockinstances[$ri->instance->id] = $ri;
107             }
109             foreach ($regionblocks as $bc) {
110                 $block = [
111                     'instanceid' => $bc->blockinstanceid,
112                     'name' => $blockinstances[$bc->blockinstanceid]->instance->blockname,
113                     'region' => $region,
114                     'positionid' => $bc->blockpositionid,
115                     'collapsible' => (bool) $bc->collapsible,
116                     'dockable' => (bool) $bc->dockable,
117                     'weight' => $blockinstances[$bc->blockinstanceid]->instance->weight,
118                     'visible' => $blockinstances[$bc->blockinstanceid]->instance->visible,
119                 ];
120                 if ($returncontents) {
121                     $block['contents'] = (array) $blockinstances[$bc->blockinstanceid]->get_content_for_external($OUTPUT);
122                 }
123                 $configs = (array) $blockinstances[$bc->blockinstanceid]->get_config_for_external();
124                 foreach ($configs as $type => $data) {
125                     foreach ((array) $data as $name => $value) {
126                         $block['configs'][] = [
127                             'name' => $name,
128                             'value' => json_encode($value), // Always JSON encode, we may receive non-scalar values.
129                             'type' => $type,
130                         ];
131                     }
132                 }
134                 $allblocks[] = $block;
135             }
136         }
137         return $allblocks;
138     }
140     /**
141      * Returns description of get_course_blocks parameters.
142      *
143      * @return external_function_parameters
144      * @since Moodle 3.3
145      */
146     public static function get_course_blocks_parameters() {
147         return new external_function_parameters(
148             array(
149                 'courseid'  => new external_value(PARAM_INT, 'course id'),
150                 'returncontents' => new external_value(PARAM_BOOL, 'Whether to return the block contents.', VALUE_DEFAULT, false),
151             )
152         );
153     }
155     /**
156      * Returns blocks information for a course.
157      *
158      * @param int $courseid The course id
159      * @param bool $returncontents Whether to return the block contents
160      * @return array Blocks list and possible warnings
161      * @throws moodle_exception
162      * @since Moodle 3.3
163      */
164     public static function get_course_blocks($courseid, $returncontents = false) {
165         global $PAGE;
167         $warnings = array();
168         $params = self::validate_parameters(self::get_course_blocks_parameters(),
169             ['courseid' => $courseid, 'returncontents' => $returncontents]);
171         $course = get_course($params['courseid']);
172         $context = context_course::instance($course->id);
173         self::validate_context($context);
175         // Specific layout for frontpage course.
176         if ($course->id == SITEID) {
177             $PAGE->set_pagelayout('frontpage');
178             $PAGE->set_pagetype('site-index');
179         } else {
180             $PAGE->set_pagelayout('course');
181             // Ensure course format is set (view course/view.php).
182             $course->format = course_get_format($course)->get_format();
183             $PAGE->set_pagetype('course-view-' . $course->format);
184         }
186         $allblocks = self::get_all_current_page_blocks(false, $params['returncontents']);
188         return array(
189             'blocks' => $allblocks,
190             'warnings' => $warnings
191         );
192     }
194     /**
195      * Returns description of get_course_blocks result values.
196      *
197      * @return external_single_structure
198      * @since Moodle 3.3
199      */
200     public static function get_course_blocks_returns() {
202         return new external_single_structure(
203             array(
204                 'blocks' => new external_multiple_structure(self::get_block_structure(), 'List of blocks in the course.'),
205                 'warnings'  => new external_warnings(),
206             )
207         );
208     }
210     /**
211      * Returns description of get_dashboard_blocks parameters.
212      *
213      * @return external_function_parameters
214      * @since Moodle 3.6
215      */
216     public static function get_dashboard_blocks_parameters() {
217         return new external_function_parameters(
218             array(
219                 'userid'  => new external_value(PARAM_INT, 'User id (optional), default is current user.', VALUE_DEFAULT, 0),
220                 'returncontents' => new external_value(PARAM_BOOL, 'Whether to return the block contents.', VALUE_DEFAULT, false),
221             )
222         );
223     }
225     /**
226      * Returns blocks information for the given user dashboard.
227      *
228      * @param int $userid The user id to retrive the blocks from, optional, default is to current user.
229      * @param bool $returncontents Whether to return the block contents
230      * @return array Blocks list and possible warnings
231      * @throws moodle_exception
232      * @since Moodle 3.6
233      */
234     public static function get_dashboard_blocks($userid = 0, $returncontents = false) {
235         global $CFG, $USER, $PAGE;
237         require_once($CFG->dirroot . '/my/lib.php');
239         $warnings = array();
240         $params = self::validate_parameters(self::get_dashboard_blocks_parameters(),
241             ['userid' => $userid, 'returncontents' => $returncontents]);
243         $userid = $params['userid'];
244         if (empty($userid)) {
245             $userid = $USER->id;
246         }
248         if ($USER->id != $userid) {
249             // We must check if the current user can view other users dashboard.
250             require_capability('moodle/site:config', context_system::instance());
251             $user = core_user::get_user($userid, '*', MUST_EXIST);
252             core_user::require_active_user($user);
253         }
255         $context = context_user::instance($userid);;
256         self::validate_context($context);
258         // Get the My Moodle page info.  Should always return something unless the database is broken.
259         if (!$currentpage = my_get_page($userid, MY_PAGE_PRIVATE)) {
260             throw new moodle_exception('mymoodlesetup');
261         }
263         $PAGE->set_context($context);
264         $PAGE->set_pagelayout('mydashboard');
265         $PAGE->set_pagetype('my-index');
266         $PAGE->blocks->add_region('content');   // Need to add this special regition to retrieve the central blocks.
267         $PAGE->set_subpage($currentpage->id);
269         // Load the block instances in the current $PAGE for all the regions.
270         $returninvisible = has_capability('moodle/my:manageblocks', $context) ? true : false;
271         $allblocks = self::get_all_current_page_blocks($returninvisible, $params['returncontents']);
273         return array(
274             'blocks' => $allblocks,
275             'warnings' => $warnings
276         );
277     }
279     /**
280      * Returns description of get_dashboard_blocks result values.
281      *
282      * @return external_single_structure
283      * @since Moodle 3.6
284      */
285     public static function get_dashboard_blocks_returns() {
287         return new external_single_structure(
288             array(
289                 'blocks' => new external_multiple_structure(self::get_block_structure(), 'List of blocks in the dashboard.'),
290                 'warnings'  => new external_warnings(),
291             )
292         );
293     }