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