weekly release 3.9dev
[moodle.git] / course / upgrade.txt
CommitLineData
9df9f1f0
JL
1This files describes API changes in /course/*,
2information provided here is intended especially for developers.
3
12f73788
JD
4=== 3.9 ===
5
6* The function get_module_metadata is now deprecated. Please use \core_course\local\service\content_item_service instead.
1e7e255d 7* Activity module names are now PARAM_ALPHANUM instead of PARAM_ALPHA so integers can be used in activity module names
12f73788 8
c128ccc1 9=== 3.8 ===
cd4abbc7 10
c128ccc1
SA
11* The following functions have been finally deprecated and can not be used any more:
12 - core_course_external::get_activities_overview
cd4abbc7
AB
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.
c128ccc1 16
76724712 17=== 3.7 ===
98c49e1a 18
620896cf
BB
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.
76724712
MJ
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)
9b8aed89 23 * External function core_course_external::get_course_contents now returns a new contentsinfo field with summary files information.
6c344ff2
JL
24 * External function core_course_external::get_course_contents now returns an additional field "tags" returning the content tags.
25
a487a3ed
DK
26=== 3.6 ===
27
1206a487 28 * External function core_course_external::get_course_public_information now returns the roles and the primary role of course
a487a3ed 29 contacts.
1206a487
JL
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))
1de51367
JL
34 - completion (to indicate if completion is enabled or not)
35 - completiondata (completion status for the current user in the module)
f3507f59 36 * External function core_group_external::get_course_user_groups now can return all user courses group information.
a487a3ed 37
8c52eb2a 38=== 3.5 ===
a487a3ed 39
7afa724c 40 * There is a new capability 'moodle/course:setforcedlanguage' to control which users can force the course
8c52eb2a 41 language; create_course and update_course functions delegate access control to the caller code; if you
7afa724c 42 are calling those functions you may be interested in checking if the logged in user has 'moodle/course:setforcedlanguage' capability.
8c52eb2a 43
e45fc71e
JL
44=== 3.3 ===
45
46 * External function core_course_external::get_courses_by_field now returns the course filters list and status.
ef83fc2a 47 * External function core_course_external::get_courses_by_field now returns the end date of the course.
dbc404de
JL
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.
935429e2
JL
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
e45fc71e 56
9df9f1f0
JL
57=== 3.2 ===
58
59 * External function core_course_external::get_course_contents now returns the section's number in the course (new section field).
82f5802a 60 * External function core_course_external::get_course_contents now returns if a section is hidden in the course format.
14590070
JL
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.
4f2378d9
FM
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
8643c576
DM
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.