course/upgrade.txt

   1 This files describes API changes in /course/*,
   2 information provided here is intended especially for developers.
   3
   4 === 4.0 ===
   5 * All activity icons have been replaced with black monochrome icons. The background
   6 colour for these icons is defined using a new 'FEATURE_MOD_PURPOSE' support variable in the module lib.php file
   7 Available purpose types are:
   8   - MOD_PURPOSE_COMMUNICATION
   9   - MOD_PURPOSE_ASSESSMENT
  10   - MOD_PURPOSE_COLLABORATION
  11   - MOD_PURPOSE_CONTENT
  12   - MOD_PURPOSE_ADMINISTRATION
  13   - MOD_PURPOSE_INTERFACE
  14   - MOD_PURPOSE_OTHER
  15 The colours for these types are defined in theme/boost/scss/moodle/variables.scss
  16 * The format_base is now deprecated. Use core_courseformat\base instead.
  17 * The new course output components deprecate many renderer methods from course
  18 renderer and course format renderer:
  19   - core_courseformat\output\local\content: to render the general course structure
  20   - core_courseformat\output\local\content\section: to render a section
  21   - core_courseformat\output\local\content\cm: to render an activity card inside a section
  22   - core_courseformat\output\local\content\cm\*: to render parts of the course structure
  23   - core_courseformat\output\local\content\section\*: to render parts of the course section
  24 * The previous format renderer page_title method has been moved to course_format::page_title
  25 * New format renderer methods to interact with the new output components:
  26   - render: override the default templatable mustache location for the new course components.
  27   - course_section_updated_cm_item: used when the course editor needs to update a cm item HTML.
  28   - render_content: contrib formats should override this method to change the default template.
  29 * The following methods are adapted to use outputs but with a deprecation warning and should not be used anymore:
  30   - print_single_section_page (replaced by core_courseformat\output\local\content)
  31   - print_multiple_section_page (replaced by core_courseformat\output\local\content)
  32   - course_activity_clipboard (integrated in replaced by core_courseformat\output\local\content)
  33   - format_summary_text (replaced by core_courseformat\output\local\content\section\summay)
  34   - change_number_sections (replaced by core_courseformat\output\local\content\addsection)
  35   - course_section_cm_list_item (replaced by core_courseformat\output\local\content\section\cmitem)
  36   - course_section_cm (replaced by core_courseformat\output\local\content\cm)
  37   - course_section_cm_list (replaced by core_courseformat\output\local\content\section\cmlist)
  38   - section_edit_control_menu (replaced by core_courseformat\output\local\content\section\controlmenu)
  39   - section_right_content (integrated in core_courseformat\output\local\content\section)
  40   - section_left_content (integrated in core_courseformat\output\local\content\section)
  41   - section_header (replaced by core_courseformat\output\local\content\section\header)
  42   - section_footer (integrated in core_courseformat\output\local\content\section)
  43   - section_edit_control_items (replaced by core_courseformat\output\local\content\section\controlmenu)
  44   - section_summary (replaced by core_courseformat\output\local\content\section\summary)
  45   - section_activity_summary (replaced by core_courseformat\output\local\content\section\cmsummary)
  46   - section_availability_message (integrated in core_courseformat\output\local\content\section\availability)
  47   - section_availability (replaced by core_courseformat\output\local\content\section\availability)
  48   - get_nav_links (replaced by core_courseformat\output\local\content\sectionnavigation)
  49   - stealth_section_header (replaced by core_courseformat\output\local\content\section\header)
  50   - stealth_section_footer (integrated in by core_courseformat\output\local\content\section)
  51   - section_nav_selection (replaced by core_courseformat\output\local\content\sectionselector)
  52   - course_section_cm_edit_actions (replaced by core_courseformat\output\local\content\cm\controlmenu)
  53   - is_cm_conditionally_hidden (incorporated in core_availability\info_module::is_available_for_all)
  54   - course_section_cm_name (replaced by core_courseformat\output\local\content\cm\cmname)
  55   - course_section_cm_classes (integrated in core_courseformat\output\local\content\cm)
  56   - course_section_cm_name_title (replaced by core_courseformat\output\local\cm\title)
  57   - course_section_cm_text (integrated in core_courseformat\output\local\content\cm)
  58   - course_section_cm_availability (replaced by core_courseformat\output\local\content\cm\availability))
  59 * The following abstract methods are deleted:
  60   - start_section_list (integrated in core_courseformat\output\local\content)
  61   - end_section_list (integrated in core_courseformat\output\local\content)
  62   - page_title (moved to core_courseformat\output\local\content)
  63 * Course formats should have a renderer (until now it was only highly recommended but not mandatory). For backwards
  64 compatibility (to not break third-party plugins without it), legacy_format_renderer has been created and will be used when
  65 course formats don't have their own renderer.
  66 * New external core_courseformat\external\get_state returns current state information for a given course.
  67 * New external core_courseformat\external\update_course runs given action to edit course and gets the affectated state objects.
  68 * New external core_course\external\get_state returns current state information for a given course.
  69 * New external function core_course_update_course runs given action to edit course status.
  70 * The `\core\event\course_category_deleted` event is now created with a snapshot of the category record being deleted,
  71   available inside event observers via `$event->get_record_snapshot`
  72 * New include_course_editor() function to include and configure course editor modules.
  73 * New core_course_drawer() function to render the message drawer in the top of the body of each page.
  74 * New course_get_enrolled_courses_for_logged_in_user_from_search which hooks in with external\get_enrolled_courses_by_timeline_classification
  75   given COURSE_TIMELINE_SEARCH is set then get_enrolled_courses_by_timeline_classification will deviate to use a string search of enrolled courses.
  76 * Class core_course\output\course_module_name is deprecated. Now core_courseformat\output\local\content\cm\cmname controls inline edit.
  77 * Calendar menu entry is now moved to User menu items, so the following methods will not return the calendar item anymore:
  78   - course_get_user_navigation_options
  79   - core_course_externalcore_course_external::get_user_navigation_options
  80 * New external \core_course\external\get_enrolled_courses_with_action_events_by_timeline_classification:
  81   - Returns courses the user is enrolled in which contain at least one action event in the supplied time/text filtering parameters.
  82   - Provides a similar response to get_enrolled_courses_by_timeline_classification, but omits courses which have no matching
  83     action events.
  84
  85 === 3.11 ===
  86 * A new callback xxx_coursemodule_definition_after_data that allows plugins to extend activity forms after the data is set.
  87 * \core_course_renderer::course_section_cm_completion() has been deprecated. It is not being used anymore and is being replaced by
  88   \core_renderer::activity_information().
  89 * New Behat steps for checking activity date information in the \behat_course class:
  90   - activity_date_in_activity_should_contain_text()
  91     - Given the activity date in "<ActivityName>" should contain "<Text>"
  92   - activity_dates_information_in_activity_should_exist()
  93     - Given the activity date information in "<ActivityName>" should exist
  94   - activity_dates_information_in_activity_should_not_exist()
  95     - Given the activity date information in "<ActivityName>" should not exist
  96 * 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.
  97
  98 === 3.10 ===
  99
 100 * The function make_categories_options() has now been deprecated. Please use \core_course_category::make_categories_list() instead.
 101 * External function core_course_external::get_course_contents now returns a new field contextid with the module context id.
 102 * The core_course_external class methods get_courses(), get_courses_by_field() and search_courses() now return a "valueraw" property
 103   for each custom course field, which contains the original/unformatted version of the custom field value.
 104
 105 === 3.9 ===
 106
 107 * The function get_module_metadata is now deprecated. Please use \core_course\local\service\content_item_service instead.
 108 * Activity module names are now PARAM_ALPHANUM instead of PARAM_ALPHA so integers can be used in activity module names
 109 * The following functions have been added to core_course_renderer class to have more granularity. They can be overriden in
 110   extending classes:
 111   - course_name
 112   - course_enrolment_icons
 113   - course_summary
 114   - course_contacts
 115   - course_overview_files
 116   - course_category_name
 117   - course_custom_fields
 118
 119 === 3.8 ===
 120
 121 * The following functions have been finally deprecated and can not be used any more:
 122   - core_course_external::get_activities_overview
 123 * External function core_course_external::get_enrolled_courses_by_timeline_classification now also supports the classification
 124   'allincludinghidden' which delivers all courses including hidden courses. The classification 'all' still returns all courses
 125   without hidden courses.
 126
 127 === 3.7 ===
 128
 129  * The course pattern function in course_summary_exporter::get_course_pattern has been moved to $OUTPUT->get_generated_image_for_id.
 130  * The course color function in course_summary_exporter::coursecolor has been moved to $OUTPUT->get_generated_color_for_id.
 131  * External function core_course_external::get_course_contents new returns the following additional completiondata field:
 132    - valueused (indicates whether the completion state affects the availability of other content)
 133  * External function core_course_external::get_course_contents now returns a new contentsinfo field with summary files information.
 134  * External function core_course_external::get_course_contents now returns an additional field "tags" returning the content tags.
 135
 136 === 3.6 ===
 137
 138  * External function core_course_external::get_course_public_information now returns the roles and the primary role of course
 139    contacts.
 140  * External function core_course_external::get_course_contents now return the following additional file fields:
 141    - onclick (onclick javascript action code)
 142    - afterlink (after link info to be displayed)
 143    - customdata (module custom data (JSON encoded))
 144    - completion (to indicate if completion is enabled or not)
 145    - completiondata (completion status for the current user in the module)
 146  * External function core_group_external::get_course_user_groups now can return all user courses group information.
 147
 148 === 3.5 ===
 149
 150  * There is a new capability 'moodle/course:setforcedlanguage' to control which users can force the course
 151    language; create_course and update_course functions delegate access control to the caller code; if you
 152    are calling those functions you may be interested in checking if the logged in user has 'moodle/course:setforcedlanguage' capability.
 153
 154 === 3.3 ===
 155
 156  * External function core_course_external::get_courses_by_field now returns the course filters list and status.
 157  * External function core_course_external::get_courses_by_field now returns the end date of the course.
 158  * External function core_course_external::get_course_contents now return the following additional file fields:
 159    - mimetype (the file mime type)
 160    - isexternalfile (if is a file reference to a external repository)
 161    - repositorytype (the repository name in case is a external file)
 162    Those fields are VALUE_OPTIONAL for backwards compatibility.
 163  * External function core_course_external::get_course_contents now return the following fields for section and modules:
 164    - uservisible (whether the section or module is visible by the user)
 165    - availabilityinfo (availability information if the course or module has any access restriction set
 166
 167 === 3.2 ===
 168
 169  * External function core_course_external::get_course_contents now returns the section's number in the course (new section field).
 170  * External function core_course_external::get_course_contents now returns if a section is hidden in the course format.
 171  * External functions that were returning file information now return the following file fields:
 172    filename, filepath, mimetype, filesize, timemodified and fileurl.
 173    Those fields are now marked as VALUE_OPTIONAL for backwards compatibility.
 174  * The modchooser now uses a renderable and a template, thus its associated renderer
 175    methods have been deprecated. Note that the call to core_course_render::course_modchooser,
 176    is still required. Deprecated methods:
 177    - core_course_renderer::course_modchooser_module_types
 178    - core_course_renderer::course_modchooser_module
 179    - core_course_renderer::course_modchooser_title
 180  * You can now specify a course end date when calling core_course_external::create_courses and core_course_external::update_courses
 181    external functions. core_course_external::get_courses external function is now returning courses end date values.