MDL-58720 course: Return restricted sections and modules in get_contents
[moodle.git] / course / upgrade.txt
1 This files describes API changes in /course/*,
2 information provided here is intended especially for developers.
4 === 3.3 ===
6  * External function core_course_external::get_courses_by_field now returns the course filters list and status.
7  * External function core_course_external::get_course_contents now return the following additional file fields:
8    - mimetype (the file mime type)
9    - isexternalfile (if is a file reference to a external repository)
10    - repositorytype (the repository name in case is a external file)
11    Those fields are VALUE_OPTIONAL for backwards compatibility.
12  * External function core_course_external::get_course_contents now return the following fields for section and modules:
13    - uservisible (whether the section or module is visible by the user)
14    - availabilityinfo (availability information if the course or module has any access restriction set
16 === 3.2 ===
18  * External function core_course_external::get_course_contents now returns the section's number in the course (new section field).
19  * External function core_course_external::get_course_contents now returns if a section is hidden in the course format.
20  * External functions that were returning file information now return the following file fields:
21    filename, filepath, mimetype, filesize, timemodified and fileurl.
22    Those fields are now marked as VALUE_OPTIONAL for backwards compatibility.
23  * The modchooser now uses a renderable and a template, thus its associated renderer
24    methods have been deprecated. Note that the call to core_course_render::course_modchooser,
25    is still required. Deprecated methods:
26    - core_course_renderer::course_modchooser_module_types
27    - core_course_renderer::course_modchooser_module
28    - core_course_renderer::course_modchooser_title
29  * You can now specify a course end date when calling core_course_external::create_courses and core_course_external::update_courses
30    external functions. core_course_external::get_courses external function is now returning courses end date values.