| Commit | Line | Data |
|---|---|---|
| 9df9f1f0 JL |
1 | This files describes API changes in /course/*, |
| 2 | information provided here is intended especially for developers. | |
| 3 | ||
| c128ccc1 | 4 | === 3.8 === |
| cd4abbc7 | 5 | |
| c128ccc1 SA |
6 | * The following functions have been finally deprecated and can not be used any more: |
| 7 | - core_course_external::get_activities_overview | |
| cd4abbc7 AB |
8 | * External function core_course_external::get_enrolled_courses_by_timeline_classification now also supports the classification |
| 9 | 'allincludinghidden' which delivers all courses including hidden courses. The classification 'all' still returns all courses | |
| 10 | without hidden courses. | |
| c128ccc1 | 11 | |
| 76724712 | 12 | === 3.7 === |
| 98c49e1a | 13 | |
| 620896cf BB |
14 | * The course pattern function in course_summary_exporter::get_course_pattern has been moved to $OUTPUT->get_generated_image_for_id. |
| 15 | * The course color function in course_summary_exporter::coursecolor has been moved to $OUTPUT->get_generated_color_for_id. | |
| 76724712 MJ |
16 | * External function core_course_external::get_course_contents new returns the following additional completiondata field: |
| 17 | - valueused (indicates whether the completion state affects the availability of other content) | |
| 9b8aed89 | 18 | * External function core_course_external::get_course_contents now returns a new contentsinfo field with summary files information. |
| 6c344ff2 JL |
19 | * External function core_course_external::get_course_contents now returns an additional field "tags" returning the content tags. |
| 20 | ||
| a487a3ed DK |
21 | === 3.6 === |
| 22 | ||
| 1206a487 | 23 | * External function core_course_external::get_course_public_information now returns the roles and the primary role of course |
| a487a3ed | 24 | contacts. |
| 1206a487 JL |
25 | * External function core_course_external::get_course_contents now return the following additional file fields: |
| 26 | - onclick (onclick javascript action code) | |
| 27 | - afterlink (after link info to be displayed) | |
| 28 | - customdata (module custom data (JSON encoded)) | |
| 1de51367 JL |
29 | - completion (to indicate if completion is enabled or not) |
| 30 | - completiondata (completion status for the current user in the module) | |
| f3507f59 | 31 | * External function core_group_external::get_course_user_groups now can return all user courses group information. |
| a487a3ed | 32 | |
| 8c52eb2a | 33 | === 3.5 === |
| a487a3ed | 34 | |
| 7afa724c | 35 | * There is a new capability 'moodle/course:setforcedlanguage' to control which users can force the course |
| 8c52eb2a | 36 | language; create_course and update_course functions delegate access control to the caller code; if you |
| 7afa724c | 37 | are calling those functions you may be interested in checking if the logged in user has 'moodle/course:setforcedlanguage' capability. |
| 8c52eb2a | 38 | |
| e45fc71e JL |
39 | === 3.3 === |
| 40 | ||
| 41 | * External function core_course_external::get_courses_by_field now returns the course filters list and status. | |
| ef83fc2a | 42 | * External function core_course_external::get_courses_by_field now returns the end date of the course. |
| dbc404de JL |
43 | * External function core_course_external::get_course_contents now return the following additional file fields: |
| 44 | - mimetype (the file mime type) | |
| 45 | - isexternalfile (if is a file reference to a external repository) | |
| 46 | - repositorytype (the repository name in case is a external file) | |
| 47 | Those fields are VALUE_OPTIONAL for backwards compatibility. | |
| 935429e2 JL |
48 | * External function core_course_external::get_course_contents now return the following fields for section and modules: |
| 49 | - uservisible (whether the section or module is visible by the user) | |
| 50 | - availabilityinfo (availability information if the course or module has any access restriction set | |
| e45fc71e | 51 | |
| 9df9f1f0 JL |
52 | === 3.2 === |
| 53 | ||
| 54 | * External function core_course_external::get_course_contents now returns the section's number in the course (new section field). | |
| 82f5802a | 55 | * External function core_course_external::get_course_contents now returns if a section is hidden in the course format. |
| 14590070 JL |
56 | * External functions that were returning file information now return the following file fields: |
| 57 | filename, filepath, mimetype, filesize, timemodified and fileurl. | |
| 58 | Those fields are now marked as VALUE_OPTIONAL for backwards compatibility. | |
| 4f2378d9 FM |
59 | * The modchooser now uses a renderable and a template, thus its associated renderer |
| 60 | methods have been deprecated. Note that the call to core_course_render::course_modchooser, | |
| 61 | is still required. Deprecated methods: | |
| 62 | - core_course_renderer::course_modchooser_module_types | |
| 63 | - core_course_renderer::course_modchooser_module | |
| 64 | - core_course_renderer::course_modchooser_title | |
| 8643c576 DM |
65 | * You can now specify a course end date when calling core_course_external::create_courses and core_course_external::update_courses |
| 66 | external functions. core_course_external::get_courses external function is now returning courses end date values. |
