Merge branch 'MDL-64884-master' of git://github.com/lameze/moodle
[moodle.git] / course / upgrade.txt
CommitLineData
9df9f1f0
JL
1This files describes API changes in /course/*,
2information provided here is intended especially for developers.
3
76724712
MJ
4=== 3.7 ===
5 * External function core_course_external::get_course_contents new returns the following additional completiondata field:
6 - valueused (indicates whether the completion state affects the availability of other content)
7
a487a3ed
DK
8=== 3.6 ===
9
1206a487 10 * External function core_course_external::get_course_public_information now returns the roles and the primary role of course
a487a3ed 11 contacts.
1206a487
JL
12 * External function core_course_external::get_course_contents now return the following additional file fields:
13 - onclick (onclick javascript action code)
14 - afterlink (after link info to be displayed)
15 - customdata (module custom data (JSON encoded))
1de51367
JL
16 - completion (to indicate if completion is enabled or not)
17 - completiondata (completion status for the current user in the module)
f3507f59 18 * External function core_group_external::get_course_user_groups now can return all user courses group information.
a487a3ed 19
8c52eb2a 20=== 3.5 ===
a487a3ed 21
7afa724c 22 * There is a new capability 'moodle/course:setforcedlanguage' to control which users can force the course
8c52eb2a 23 language; create_course and update_course functions delegate access control to the caller code; if you
7afa724c 24 are calling those functions you may be interested in checking if the logged in user has 'moodle/course:setforcedlanguage' capability.
8c52eb2a 25
e45fc71e
JL
26=== 3.3 ===
27
28 * External function core_course_external::get_courses_by_field now returns the course filters list and status.
ef83fc2a 29 * External function core_course_external::get_courses_by_field now returns the end date of the course.
dbc404de
JL
30 * External function core_course_external::get_course_contents now return the following additional file fields:
31 - mimetype (the file mime type)
32 - isexternalfile (if is a file reference to a external repository)
33 - repositorytype (the repository name in case is a external file)
34 Those fields are VALUE_OPTIONAL for backwards compatibility.
935429e2
JL
35 * External function core_course_external::get_course_contents now return the following fields for section and modules:
36 - uservisible (whether the section or module is visible by the user)
37 - availabilityinfo (availability information if the course or module has any access restriction set
e45fc71e 38
9df9f1f0
JL
39=== 3.2 ===
40
41 * External function core_course_external::get_course_contents now returns the section's number in the course (new section field).
82f5802a 42 * External function core_course_external::get_course_contents now returns if a section is hidden in the course format.
14590070
JL
43 * External functions that were returning file information now return the following file fields:
44 filename, filepath, mimetype, filesize, timemodified and fileurl.
45 Those fields are now marked as VALUE_OPTIONAL for backwards compatibility.
4f2378d9
FM
46 * The modchooser now uses a renderable and a template, thus its associated renderer
47 methods have been deprecated. Note that the call to core_course_render::course_modchooser,
48 is still required. Deprecated methods:
49 - core_course_renderer::course_modchooser_module_types
50 - core_course_renderer::course_modchooser_module
51 - core_course_renderer::course_modchooser_title
8643c576
DM
52 * You can now specify a course end date when calling core_course_external::create_courses and core_course_external::update_courses
53 external functions. core_course_external::get_courses external function is now returning courses end date values.