1 This files describes API changes in /course/*,
2 information provided here is intended especially for developers.
5 * course/mod.php now accepts parameter beforemod for adding course modules. It contains the course module id
6 of an existing course module. The new module is inserted before this module.
7 * The function duplicate_module() now has two new optional parameters:
8 - $sectionid to specify section the duplicated course module is placed in
9 - $changename to disable changing the name of the course module using the 'duplicatedmodule' lang string
12 * The function course_modchooser() has been finally deprecated and can not be used anymore. Please use
13 course_activitychooser() instead.
14 * A critical accessibility issue is been found (MDL-74800) at the output class
15 core_courseformat\output\local\content\cm\cmname. To solve the problem this output element is not
16 rendered anymore using inplace_editable but using a regular named_templatable interface.
17 Some format plugins that override the deprecated renderer method course_section_cm_name can be affected.
18 Check the current course_section_cm_name code to see how to render it properly.
21 * All activity icons have been replaced with black monochrome icons. The background
22 colour for these icons is defined using a new 'FEATURE_MOD_PURPOSE' support variable in the module lib.php file
23 Available purpose types are:
24 - MOD_PURPOSE_COMMUNICATION
25 - MOD_PURPOSE_ASSESSMENT
26 - MOD_PURPOSE_COLLABORATION
28 - MOD_PURPOSE_ADMINISTRATION
29 - MOD_PURPOSE_INTERFACE
31 The colours for these types are defined in theme/boost/scss/moodle/variables.scss
32 * The format_base is now deprecated. Use core_courseformat\base instead.
33 * The new course output components deprecate many renderer methods from course
34 renderer and course format renderer:
35 - core_courseformat\output\local\content: to render the general course structure
36 - core_courseformat\output\local\content\section: to render a section
37 - core_courseformat\output\local\content\cm: to render an activity card inside a section
38 - core_courseformat\output\local\content\cm\*: to render parts of the course structure
39 - core_courseformat\output\local\content\section\*: to render parts of the course section
40 * The previous format renderer page_title method has been moved to course_format::page_title
41 * New format renderer methods to interact with the new output components:
42 - render: override the default templatable mustache location for the new course components.
43 - course_section_updated_cm_item: used when the course editor needs to update a cm item HTML.
44 - render_content: contrib formats should override this method to change the default template.
45 * The following methods are adapted to use outputs but with a deprecation warning and should not be used anymore:
46 - print_single_section_page (replaced by core_courseformat\output\local\content)
47 - print_multiple_section_page (replaced by core_courseformat\output\local\content)
48 - course_activity_clipboard (integrated in replaced by core_courseformat\output\local\content)
49 - format_summary_text (replaced by core_courseformat\output\local\content\section\summay)
50 - change_number_sections (replaced by core_courseformat\output\local\content\addsection)
51 - course_section_cm_list_item (replaced by core_courseformat\output\local\content\section\cmitem)
52 - course_section_cm (replaced by core_courseformat\output\local\content\cm)
53 - course_section_cm_list (replaced by core_courseformat\output\local\content\section\cmlist)
54 - section_edit_control_menu (replaced by core_courseformat\output\local\content\section\controlmenu)
55 - section_right_content (integrated in core_courseformat\output\local\content\section)
56 - section_left_content (integrated in core_courseformat\output\local\content\section)
57 - section_header (replaced by core_courseformat\output\local\content\section\header)
58 - section_footer (integrated in core_courseformat\output\local\content\section)
59 - section_edit_control_items (replaced by core_courseformat\output\local\content\section\controlmenu)
60 - section_summary (replaced by core_courseformat\output\local\content\section\summary)
61 - section_activity_summary (replaced by core_courseformat\output\local\content\section\cmsummary)
62 - section_availability_message (integrated in core_courseformat\output\local\content\section\availability)
63 - section_availability (replaced by core_courseformat\output\local\content\section\availability)
64 - get_nav_links (replaced by core_courseformat\output\local\content\sectionnavigation)
65 - stealth_section_header (replaced by core_courseformat\output\local\content\section\header)
66 - stealth_section_footer (integrated in by core_courseformat\output\local\content\section)
67 - section_nav_selection (replaced by core_courseformat\output\local\content\sectionselector)
68 - course_section_cm_edit_actions (replaced by core_courseformat\output\local\content\cm\controlmenu)
69 - is_cm_conditionally_hidden (incorporated in core_availability\info_module::is_available_for_all)
70 - course_section_cm_name (replaced by core_courseformat\output\local\content\cm\cmname)
71 - course_section_cm_classes (integrated in core_courseformat\output\local\content\cm)
72 - course_section_cm_name_title (replaced by core_courseformat\output\local\cm\title)
73 - course_section_cm_text (integrated in core_courseformat\output\local\content\cm)
74 - course_section_cm_availability (replaced by core_courseformat\output\local\content\cm\availability))
75 - start_section_list (integrated in core_courseformat\output\local\content)
76 - end_section_list (integrated in core_courseformat\output\local\content)
77 * The following abstract methods are deleted:
78 - page_title (moved to core_courseformat\output\local\content)
79 * Course formats should have a renderer (until now it was only highly recommended but not mandatory). For backwards
80 compatibility (to not break third-party plugins without it), legacy_format_renderer has been created and will be used when
81 course formats don't have their own renderer.
82 * New external core_courseformat\external\get_state returns current state information for a given course.
83 * New external core_courseformat\external\update_course runs given action to edit course and gets the affectated state objects.
84 * New external core_course\external\get_state returns current state information for a given course.
85 * New external function core_course_update_course runs given action to edit course status.
86 * The `\core\event\course_category_deleted` event is now created with a snapshot of the category record being deleted,
87 available inside event observers via `$event->get_record_snapshot`
88 * New include_course_editor() function to include and configure course editor modules.
89 * New core_course_drawer() function to render the message drawer in the top of the body of each page.
90 * New course_get_enrolled_courses_for_logged_in_user_from_search which hooks in with external\get_enrolled_courses_by_timeline_classification
91 given COURSE_TIMELINE_SEARCH is set then get_enrolled_courses_by_timeline_classification will deviate to use a string search of enrolled courses.
92 * Class core_course\output\course_module_name is deprecated. Now core_courseformat\output\local\content\cm\cmname controls inline edit.
93 * Calendar menu entry is now moved to User menu items, so the following methods will not return the calendar item anymore:
94 - course_get_user_navigation_options
95 - core_course_externalcore_course_external::get_user_navigation_options
96 * New external \core_course\external\get_enrolled_courses_with_action_events_by_timeline_classification:
97 - Returns courses the user is enrolled in which contain at least one action event in the supplied time/text filtering parameters.
98 - Provides a similar response to get_enrolled_courses_by_timeline_classification, but omits courses which have no matching
100 * The following functions have been deprecated in favour the tertiary navigation constructs:
103 - print_course_request_buttons
104 * New page_setup() method in the core_course_category class. This method can be used for a general page setup in the course
106 * New core_course_category::get_nearest_editable_subcategory():
107 - Return the core_course_category object for the first subcategory that the current user has the permission on it.
108 * The method navigation() in the core_course_bulk_activity_completion_renderer class has been deprecated as the tabs navigation
109 structure in the course competency pages has been replaced with tertiary navigation. To render the navigation, please
110 render_course_completion_action_bar() instead.
111 * The following functions have been deprecated in favour partial course cache rebuild:
112 - course_purge_section_cache (replaced by course_modinfo::purge_course_section_cache_by_id() and course_modinfo::purge_course_section_cache_by_number())
113 - course_purge_module_cache (replaced by course_modinfo::purge_course_module_cache())
114 - get_array_of_activities (replaced by course_modinfo::get_array_of_activities() for better performance)
115 * New course_modinfo::purge_course_cache function was created to purge the cache of a given course.
118 * A new callback xxx_coursemodule_definition_after_data that allows plugins to extend activity forms after the data is set.
119 * \core_course_renderer::course_section_cm_completion() has been deprecated. It is not being used anymore and is being replaced by
120 \core_renderer::activity_information().
121 * New Behat steps for checking activity date information in the \behat_course class:
122 - activity_date_in_activity_should_contain_text()
123 - Given the activity date in "<ActivityName>" should contain "<Text>"
124 - activity_dates_information_in_activity_should_exist()
125 - Given the activity date information in "<ActivityName>" should exist
126 - activity_dates_information_in_activity_should_not_exist()
127 - Given the activity date information in "<ActivityName>" should not exist
128 * A user preference usemodchooser has been removed and the activities/resources (non-ajax) activity chooser has been deprecated and will be removed in the future.
132 * The function make_categories_options() has now been deprecated. Please use \core_course_category::make_categories_list() instead.
133 * External function core_course_external::get_course_contents now returns a new field contextid with the module context id.
134 * The core_course_external class methods get_courses(), get_courses_by_field() and search_courses() now return a "valueraw" property
135 for each custom course field, which contains the original/unformatted version of the custom field value.
139 * The function get_module_metadata is now deprecated. Please use \core_course\local\service\content_item_service instead.
140 * Activity module names are now PARAM_ALPHANUM instead of PARAM_ALPHA so integers can be used in activity module names
141 * The following functions have been added to core_course_renderer class to have more granularity. They can be overriden in
144 - course_enrolment_icons
147 - course_overview_files
148 - course_category_name
149 - course_custom_fields
153 * The following functions have been finally deprecated and can not be used any more:
154 - core_course_external::get_activities_overview
155 * External function core_course_external::get_enrolled_courses_by_timeline_classification now also supports the classification
156 'allincludinghidden' which delivers all courses including hidden courses. The classification 'all' still returns all courses
157 without hidden courses.
161 * The course pattern function in course_summary_exporter::get_course_pattern has been moved to $OUTPUT->get_generated_image_for_id.
162 * The course color function in course_summary_exporter::coursecolor has been moved to $OUTPUT->get_generated_color_for_id.
163 * External function core_course_external::get_course_contents new returns the following additional completiondata field:
164 - valueused (indicates whether the completion state affects the availability of other content)
165 * External function core_course_external::get_course_contents now returns a new contentsinfo field with summary files information.
166 * External function core_course_external::get_course_contents now returns an additional field "tags" returning the content tags.
170 * External function core_course_external::get_course_public_information now returns the roles and the primary role of course
172 * External function core_course_external::get_course_contents now return the following additional file fields:
173 - onclick (onclick javascript action code)
174 - afterlink (after link info to be displayed)
175 - customdata (module custom data (JSON encoded))
176 - completion (to indicate if completion is enabled or not)
177 - completiondata (completion status for the current user in the module)
178 * External function core_group_external::get_course_user_groups now can return all user courses group information.
182 * There is a new capability 'moodle/course:setforcedlanguage' to control which users can force the course
183 language; create_course and update_course functions delegate access control to the caller code; if you
184 are calling those functions you may be interested in checking if the logged in user has 'moodle/course:setforcedlanguage' capability.
188 * External function core_course_external::get_courses_by_field now returns the course filters list and status.
189 * External function core_course_external::get_courses_by_field now returns the end date of the course.
190 * External function core_course_external::get_course_contents now return the following additional file fields:
191 - mimetype (the file mime type)
192 - isexternalfile (if is a file reference to a external repository)
193 - repositorytype (the repository name in case is a external file)
194 Those fields are VALUE_OPTIONAL for backwards compatibility.
195 * External function core_course_external::get_course_contents now return the following fields for section and modules:
196 - uservisible (whether the section or module is visible by the user)
197 - availabilityinfo (availability information if the course or module has any access restriction set
201 * External function core_course_external::get_course_contents now returns the section's number in the course (new section field).
202 * External function core_course_external::get_course_contents now returns if a section is hidden in the course format.
203 * External functions that were returning file information now return the following file fields:
204 filename, filepath, mimetype, filesize, timemodified and fileurl.
205 Those fields are now marked as VALUE_OPTIONAL for backwards compatibility.
206 * The modchooser now uses a renderable and a template, thus its associated renderer
207 methods have been deprecated. Note that the call to core_course_render::course_modchooser,
208 is still required. Deprecated methods:
209 - core_course_renderer::course_modchooser_module_types
210 - core_course_renderer::course_modchooser_module
211 - core_course_renderer::course_modchooser_title
212 * You can now specify a course end date when calling core_course_external::create_courses and core_course_external::update_courses
213 external functions. core_course_external::get_courses external function is now returning courses end date values.