[moodle.git] / course / upgrade.txt
1 This files describes API changes in /course/*,
2 information provided here is intended especially for developers.
4 === 3.9 ===
6 * The function get_module_metadata is now deprecated. Please use \core_course\local\service\content_item_service instead.
7 * Activity module names are now PARAM_ALPHANUM instead of PARAM_ALPHA so integers can be used in activity module names
9 === 3.8 ===
11 * The following functions have been finally deprecated and can not be used any more:
12   - core_course_external::get_activities_overview
13 * External function core_course_external::get_enrolled_courses_by_timeline_classification now also supports the classification
14   'allincludinghidden' which delivers all courses including hidden courses. The classification 'all' still returns all courses
15   without hidden courses.
17 === 3.7 ===
19  * The course pattern function in course_summary_exporter::get_course_pattern has been moved to $OUTPUT->get_generated_image_for_id.
20  * The course color function in course_summary_exporter::coursecolor has been moved to $OUTPUT->get_generated_color_for_id.
21  * External function core_course_external::get_course_contents new returns the following additional completiondata field:
22    - valueused (indicates whether the completion state affects the availability of other content)
23  * External function core_course_external::get_course_contents now returns a new contentsinfo field with summary files information.
24  * External function core_course_external::get_course_contents now returns an additional field "tags" returning the content tags.
26 === 3.6 ===
28  * External function core_course_external::get_course_public_information now returns the roles and the primary role of course
29    contacts.
30  * External function core_course_external::get_course_contents now return the following additional file fields:
31    - onclick (onclick javascript action code)
32    - afterlink (after link info to be displayed)
33    - customdata (module custom data (JSON encoded))
34    - completion (to indicate if completion is enabled or not)
35    - completiondata (completion status for the current user in the module)
36  * External function core_group_external::get_course_user_groups now can return all user courses group information.
38 === 3.5 ===
40  * There is a new capability 'moodle/course:setforcedlanguage' to control which users can force the course
41    language; create_course and update_course functions delegate access control to the caller code; if you
42    are calling those functions you may be interested in checking if the logged in user has 'moodle/course:setforcedlanguage' capability.
44 === 3.3 ===
46  * External function core_course_external::get_courses_by_field now returns the course filters list and status.
47  * External function core_course_external::get_courses_by_field now returns the end date of the course.
48  * External function core_course_external::get_course_contents now return the following additional file fields:
49    - mimetype (the file mime type)
50    - isexternalfile (if is a file reference to a external repository)
51    - repositorytype (the repository name in case is a external file)
52    Those fields are VALUE_OPTIONAL for backwards compatibility.
53  * External function core_course_external::get_course_contents now return the following fields for section and modules:
54    - uservisible (whether the section or module is visible by the user)
55    - availabilityinfo (availability information if the course or module has any access restriction set
57 === 3.2 ===
59  * External function core_course_external::get_course_contents now returns the section's number in the course (new section field).
60  * External function core_course_external::get_course_contents now returns if a section is hidden in the course format.
61  * External functions that were returning file information now return the following file fields:
62    filename, filepath, mimetype, filesize, timemodified and fileurl.
63    Those fields are now marked as VALUE_OPTIONAL for backwards compatibility.
64  * The modchooser now uses a renderable and a template, thus its associated renderer
65    methods have been deprecated. Note that the call to core_course_render::course_modchooser,
66    is still required. Deprecated methods:
67    - core_course_renderer::course_modchooser_module_types
68    - core_course_renderer::course_modchooser_module
69    - core_course_renderer::course_modchooser_title
70  * You can now specify a course end date when calling core_course_external::create_courses and core_course_external::update_courses
71    external functions. core_course_external::get_courses external function is now returning courses end date values.