Merge branch 'MDL-61801-33' of git://github.com/andrewnicols/moodle into MOODLE_33_STABLE
[moodle.git] / course / upgrade.txt
blob7f0cc376ce4e58e4dc4c3ee9bb657c2690083309
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_courses_by_field now returns the end date of the course.
8  * External function core_course_external::get_course_contents now return the following additional file fields:
9    - mimetype (the file mime type)
10    - isexternalfile (if is a file reference to a external repository)
11    - repositorytype (the repository name in case is a external file)
12    Those fields are VALUE_OPTIONAL for backwards compatibility.
13  * External function core_course_external::get_course_contents now return the following fields for section and modules:
14    - uservisible (whether the section or module is visible by the user)
15    - availabilityinfo (availability information if the course or module has any access restriction set
17 === 3.2 ===
19  * External function core_course_external::get_course_contents now returns the section's number in the course (new section field).
20  * External function core_course_external::get_course_contents now returns if a section is hidden in the course format.
21  * External functions that were returning file information now return the following file fields:
22    filename, filepath, mimetype, filesize, timemodified and fileurl.
23    Those fields are now marked as VALUE_OPTIONAL for backwards compatibility.
24  * The modchooser now uses a renderable and a template, thus its associated renderer
25    methods have been deprecated. Note that the call to core_course_render::course_modchooser,
26    is still required. Deprecated methods:
27    - core_course_renderer::course_modchooser_module_types
28    - core_course_renderer::course_modchooser_module
29    - core_course_renderer::course_modchooser_title
30  * You can now specify a course end date when calling core_course_external::create_courses and core_course_external::update_courses
31    external functions. core_course_external::get_courses external function is now returning courses end date values.