Differences Between: [Versions 311 and 400] [Versions 311 and 401] [Versions 311 and 402] [Versions 311 and 403] [Versions 39 and 311]
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 /** 18 * folder external API 19 * 20 * @package mod_folder 21 * @category external 22 * @copyright 2015 Juan Leyva <juan@moodle.com> 23 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later 24 * @since Moodle 3.0 25 */ 26 27 defined('MOODLE_INTERNAL') || die; 28 29 require_once("$CFG->libdir/externallib.php"); 30 31 /** 32 * folder external functions 33 * 34 * @package mod_folder 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.0 39 */ 40 class mod_folder_external extends external_api { 41 42 /** 43 * Returns description of method parameters 44 * 45 * @return external_function_parameters 46 * @since Moodle 3.0 47 */ 48 public static function view_folder_parameters() { 49 return new external_function_parameters( 50 array( 51 'folderid' => new external_value(PARAM_INT, 'folder instance id') 52 ) 53 ); 54 } 55 56 /** 57 * Simulate the folder/view.php web interface page: trigger events, completion, etc... 58 * 59 * @param int $folderid the folder instance id 60 * @return array of warnings and status result 61 * @since Moodle 3.0 62 * @throws moodle_exception 63 */ 64 public static function view_folder($folderid) { 65 global $DB, $CFG; 66 require_once($CFG->dirroot . "/mod/folder/lib.php"); 67 68 $params = self::validate_parameters(self::view_folder_parameters(), 69 array( 70 'folderid' => $folderid 71 )); 72 $warnings = array(); 73 74 // Request and permission validation. 75 $folder = $DB->get_record('folder', array('id' => $params['folderid']), '*', MUST_EXIST); 76 list($course, $cm) = get_course_and_cm_from_instance($folder, 'folder'); 77 78 $context = context_module::instance($cm->id); 79 self::validate_context($context); 80 81 require_capability('mod/folder:view', $context); 82 83 // Call the page/lib API. 84 folder_view($folder, $course, $cm, $context); 85 86 $result = array(); 87 $result['status'] = true; 88 $result['warnings'] = $warnings; 89 return $result; 90 } 91 92 /** 93 * Returns description of method result value 94 * 95 * @return external_description 96 * @since Moodle 3.0 97 */ 98 public static function view_folder_returns() { 99 return new external_single_structure( 100 array( 101 'status' => new external_value(PARAM_BOOL, 'status: true if success'), 102 'warnings' => new external_warnings() 103 ) 104 ); 105 } 106 107 /** 108 * Describes the parameters for get_folders_by_courses. 109 * 110 * @return external_function_parameters 111 * @since Moodle 3.3 112 */ 113 public static function get_folders_by_courses_parameters() { 114 return new external_function_parameters ( 115 array( 116 'courseids' => new external_multiple_structure( 117 new external_value(PARAM_INT, 'Course id'), 'Array of course ids', VALUE_DEFAULT, array() 118 ), 119 ) 120 ); 121 } 122 123 /** 124 * Returns a list of folders in a provided list of courses. 125 * If no list is provided all folders that the user can view will be returned. 126 * 127 * @param array $courseids course ids 128 * @return array of warnings and folders 129 * @since Moodle 3.3 130 */ 131 public static function get_folders_by_courses($courseids = array()) { 132 133 $warnings = array(); 134 $returnedfolders = array(); 135 136 $params = array( 137 'courseids' => $courseids, 138 ); 139 $params = self::validate_parameters(self::get_folders_by_courses_parameters(), $params); 140 141 $mycourses = array(); 142 if (empty($params['courseids'])) { 143 $mycourses = enrol_get_my_courses(); 144 $params['courseids'] = array_keys($mycourses); 145 } 146 147 // Ensure there are courseids to loop through. 148 if (!empty($params['courseids'])) { 149 150 list($courses, $warnings) = external_util::validate_courses($params['courseids'], $mycourses); 151 152 // Get the folders in this course, this function checks users visibility permissions. 153 // We can avoid then additional validate_context calls. 154 $folders = get_all_instances_in_courses("folder", $courses); 155 foreach ($folders as $folder) { 156 $context = context_module::instance($folder->coursemodule); 157 // Entry to return. 158 $folder->name = external_format_string($folder->name, $context->id); 159 160 $options = array('noclean' => true); 161 list($folder->intro, $folder->introformat) = 162 external_format_text($folder->intro, $folder->introformat, $context->id, 'mod_folder', 'intro', null, $options); 163 $folder->introfiles = external_util::get_area_files($context->id, 'mod_folder', 'intro', false, false); 164 165 $returnedfolders[] = $folder; 166 } 167 } 168 169 $result = array( 170 'folders' => $returnedfolders, 171 'warnings' => $warnings 172 ); 173 return $result; 174 } 175 176 /** 177 * Describes the get_folders_by_courses return value. 178 * 179 * @return external_single_structure 180 * @since Moodle 3.3 181 */ 182 public static function get_folders_by_courses_returns() { 183 return new external_single_structure( 184 array( 185 'folders' => new external_multiple_structure( 186 new external_single_structure( 187 array( 188 'id' => new external_value(PARAM_INT, 'Module id'), 189 'coursemodule' => new external_value(PARAM_INT, 'Course module id'), 190 'course' => new external_value(PARAM_INT, 'Course id'), 191 'name' => new external_value(PARAM_RAW, 'Page name'), 192 'intro' => new external_value(PARAM_RAW, 'Summary'), 193 'introformat' => new external_format_value('intro', 'Summary format'), 194 'introfiles' => new external_files('Files in the introduction text'), 195 'revision' => new external_value(PARAM_INT, 'Incremented when after each file changes, to avoid cache'), 196 'timemodified' => new external_value(PARAM_INT, 'Last time the folder was modified'), 197 'display' => new external_value(PARAM_INT, 'Display type of folder contents on a separate page or inline'), 198 'showexpanded' => new external_value(PARAM_INT, '1 = expanded, 0 = collapsed for sub-folders'), 199 'showdownloadfolder' => new external_value(PARAM_INT, 'Whether to show the download folder button'), 200 'forcedownload' => new external_value(PARAM_INT, 'Whether file download is forced'), 201 'section' => new external_value(PARAM_INT, 'Course section id'), 202 'visible' => new external_value(PARAM_INT, 'Module visibility'), 203 'groupmode' => new external_value(PARAM_INT, 'Group mode'), 204 'groupingid' => new external_value(PARAM_INT, 'Grouping id'), 205 ) 206 ) 207 ), 208 'warnings' => new external_warnings(), 209 ) 210 ); 211 } 212 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body