Merge branch 'MDL-62560-master'
[moodle.git] / course / upgrade.txt
blobd95217078aa317bccbb5e8ca2bf2bb83efaa80e8
1 This files describes API changes in /course/*,
2 information provided here is intended especially for developers.
4 === 3.6 ===
6   * External function core_course_external::get_course_public_information now returns the roles and the primary role of course
7    contacts.
9 === 3.5 ===
11  * There is a new capability 'moodle/course:setforcedlanguage' to control which users can force the course
12    language; create_course and update_course functions delegate access control to the caller code; if you
13    are calling those functions you may be interested in checking if the logged in user has 'moodle/course:setforcedlanguage' capability.
15 === 3.3 ===
17  * External function core_course_external::get_courses_by_field now returns the course filters list and status.
18  * External function core_course_external::get_courses_by_field now returns the end date of the course.
19  * External function core_course_external::get_course_contents now return the following additional file fields:
20    - mimetype (the file mime type)
21    - isexternalfile (if is a file reference to a external repository)
22    - repositorytype (the repository name in case is a external file)
23    Those fields are VALUE_OPTIONAL for backwards compatibility.
24  * External function core_course_external::get_course_contents now return the following fields for section and modules:
25    - uservisible (whether the section or module is visible by the user)
26    - availabilityinfo (availability information if the course or module has any access restriction set
28 === 3.2 ===
30  * External function core_course_external::get_course_contents now returns the section's number in the course (new section field).
31  * External function core_course_external::get_course_contents now returns if a section is hidden in the course format.
32  * External functions that were returning file information now return the following file fields:
33    filename, filepath, mimetype, filesize, timemodified and fileurl.
34    Those fields are now marked as VALUE_OPTIONAL for backwards compatibility.
35  * The modchooser now uses a renderable and a template, thus its associated renderer
36    methods have been deprecated. Note that the call to core_course_render::course_modchooser,
37    is still required. Deprecated methods:
38    - core_course_renderer::course_modchooser_module_types
39    - core_course_renderer::course_modchooser_module
40    - core_course_renderer::course_modchooser_title
41  * You can now specify a course end date when calling core_course_external::create_courses and core_course_external::update_courses
42    external functions. core_course_external::get_courses external function is now returning courses end date values.