Merge branch 'MDL-61197-master' of git://github.com/jleyva/moodle
[moodle.git] / course / upgrade.txt
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.
8  * External function core_course_external::get_course_contents now return the following additional file fields:
9    - onclick (onclick javascript action code)
10    - afterlink (after link info to be displayed)
11    - customdata (module custom data (JSON encoded))
12    - completion (to indicate if completion is enabled or not)
13    - completiondata (completion status for the current user in the module)
14  * External function core_group_external::get_course_user_groups now can return all user courses group information.
16 === 3.5 ===
18  * There is a new capability 'moodle/course:setforcedlanguage' to control which users can force the course
19    language; create_course and update_course functions delegate access control to the caller code; if you
20    are calling those functions you may be interested in checking if the logged in user has 'moodle/course:setforcedlanguage' capability.
22 === 3.3 ===
24  * External function core_course_external::get_courses_by_field now returns the course filters list and status.
25  * External function core_course_external::get_courses_by_field now returns the end date of the course.
26  * External function core_course_external::get_course_contents now return the following additional file fields:
27    - mimetype (the file mime type)
28    - isexternalfile (if is a file reference to a external repository)
29    - repositorytype (the repository name in case is a external file)
30    Those fields are VALUE_OPTIONAL for backwards compatibility.
31  * External function core_course_external::get_course_contents now return the following fields for section and modules:
32    - uservisible (whether the section or module is visible by the user)
33    - availabilityinfo (availability information if the course or module has any access restriction set
35 === 3.2 ===
37  * External function core_course_external::get_course_contents now returns the section's number in the course (new section field).
38  * External function core_course_external::get_course_contents now returns if a section is hidden in the course format.
39  * External functions that were returning file information now return the following file fields:
40    filename, filepath, mimetype, filesize, timemodified and fileurl.
41    Those fields are now marked as VALUE_OPTIONAL for backwards compatibility.
42  * The modchooser now uses a renderable and a template, thus its associated renderer
43    methods have been deprecated. Note that the call to core_course_render::course_modchooser,
44    is still required. Deprecated methods:
45    - core_course_renderer::course_modchooser_module_types
46    - core_course_renderer::course_modchooser_module
47    - core_course_renderer::course_modchooser_title
48  * You can now specify a course end date when calling core_course_external::create_courses and core_course_external::update_courses
49    external functions. core_course_external::get_courses external function is now returning courses end date values.