course/upgrade.txt

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