upgrade.txt 3.96 KB
Newer Older
1
2
3
This files describes API changes in /course/*,
information provided here is intended especially for developers.

4
5
6
7
=== 3.8 ===
* The following functions have been finally deprecated and can not be used any more:
  - core_course_external::get_activities_overview

8
=== 3.7 ===
9

10
11
 * The course pattern function in course_summary_exporter::get_course_pattern has been moved to $OUTPUT->get_generated_image_for_id.
 * The course color function in course_summary_exporter::coursecolor has been moved to $OUTPUT->get_generated_color_for_id.
12
13
 * External function core_course_external::get_course_contents new returns the following additional completiondata field:
   - valueused (indicates whether the completion state affects the availability of other content)
14
 * External function core_course_external::get_course_contents now returns a new contentsinfo field with summary files information.
15
16
 * External function core_course_external::get_course_contents now returns an additional field "tags" returning the content tags.

17
18
=== 3.6 ===

19
 * External function core_course_external::get_course_public_information now returns the roles and the primary role of course
20
   contacts.
21
22
23
24
 * External function core_course_external::get_course_contents now return the following additional file fields:
   - onclick (onclick javascript action code)
   - afterlink (after link info to be displayed)
   - customdata (module custom data (JSON encoded))
25
26
   - completion (to indicate if completion is enabled or not)
   - completiondata (completion status for the current user in the module)
27
 * External function core_group_external::get_course_user_groups now can return all user courses group information.
28

29
=== 3.5 ===
30

31
 * There is a new capability 'moodle/course:setforcedlanguage' to control which users can force the course
32
   language; create_course and update_course functions delegate access control to the caller code; if you
33
   are calling those functions you may be interested in checking if the logged in user has 'moodle/course:setforcedlanguage' capability.
34

35
36
37
=== 3.3 ===

 * External function core_course_external::get_courses_by_field now returns the course filters list and status.
38
 * External function core_course_external::get_courses_by_field now returns the end date of the course.
39
40
41
42
43
 * External function core_course_external::get_course_contents now return the following additional file fields:
   - mimetype (the file mime type)
   - isexternalfile (if is a file reference to a external repository)
   - repositorytype (the repository name in case is a external file)
   Those fields are VALUE_OPTIONAL for backwards compatibility.
44
45
46
 * External function core_course_external::get_course_contents now return the following fields for section and modules:
   - uservisible (whether the section or module is visible by the user)
   - availabilityinfo (availability information if the course or module has any access restriction set
47

48
49
50
=== 3.2 ===

 * External function core_course_external::get_course_contents now returns the section's number in the course (new section field).
51
 * External function core_course_external::get_course_contents now returns if a section is hidden in the course format.
52
53
54
 * External functions that were returning file information now return the following file fields:
   filename, filepath, mimetype, filesize, timemodified and fileurl.
   Those fields are now marked as VALUE_OPTIONAL for backwards compatibility.
55
56
57
58
59
60
 * The modchooser now uses a renderable and a template, thus its associated renderer
   methods have been deprecated. Note that the call to core_course_render::course_modchooser,
   is still required. Deprecated methods:
   - core_course_renderer::course_modchooser_module_types
   - core_course_renderer::course_modchooser_module
   - core_course_renderer::course_modchooser_title
61
62
 * You can now specify a course end date when calling core_course_external::create_courses and core_course_external::update_courses
   external functions. core_course_external::get_courses external function is now returning courses end date values.