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

4
5
6
=== 3.9 ===

* 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
8

9
=== 3.8 ===
10

11
12
* The following functions have been finally deprecated and can not be used any more:
  - core_course_external::get_activities_overview
13
14
15
* External function core_course_external::get_enrolled_courses_by_timeline_classification now also supports the classification
  'allincludinghidden' which delivers all courses including hidden courses. The classification 'all' still returns all courses
  without hidden courses.
16

17
=== 3.7 ===
18

19
20
 * 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.
21
22
 * 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)
23
 * External function core_course_external::get_course_contents now returns a new contentsinfo field with summary files information.
24
25
 * External function core_course_external::get_course_contents now returns an additional field "tags" returning the content tags.

26
27
=== 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
31
32
33
 * 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))
34
35
   - completion (to indicate if completion is enabled or not)
   - 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.
37

38
=== 3.5 ===
39

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.
43

44
45
46
=== 3.3 ===

 * 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
49
50
51
52
 * 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.
53
54
55
 * 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
56

57
58
59
=== 3.2 ===

 * 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
62
63
 * 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.
64
65
66
67
68
69
 * 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
70
71
 * 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.