course/upgrade.txt

   1 This files describes API changes in /course/*,
   2 information provided here is intended especially for developers.
   3
   4 === 3.10 ===
   5
   6 * The function make_categories_options() has now been deprecated. Please use \core_course_category::make_categories_list() instead.
   7 * External function core_course_external::get_course_contents now returns a new field contextid with the module context id.
   8 * The core_course_external class methods get_courses(), get_courses_by_field() and search_courses() now return a "valueraw" property
   9   for each custom course field, which contains the original/unformatted version of the custom field value.
  10 * The `\core\event\course_category_deleted` event is now created with a snapshot of the category record being deleted,
  11   available inside event observers via `$event->get_record_snapshot`
  12
  13 === 3.9 ===
  14
  15 * The function get_module_metadata is now deprecated. Please use \core_course\local\service\content_item_service instead.
  16 * Activity module names are now PARAM_ALPHANUM instead of PARAM_ALPHA so integers can be used in activity module names
  17 * The following functions have been added to core_course_renderer class to have more granularity. They can be overriden in
  18   extending classes:
  19   - course_name
  20   - course_enrolment_icons
  21   - course_summary
  22   - course_contacts
  23   - course_overview_files
  24   - course_category_name
  25   - course_custom_fields
  26
  27 === 3.8 ===
  28
  29 * The following functions have been finally deprecated and can not be used any more:
  30   - core_course_external::get_activities_overview
  31 * External function core_course_external::get_enrolled_courses_by_timeline_classification now also supports the classification
  32   'allincludinghidden' which delivers all courses including hidden courses. The classification 'all' still returns all courses
  33   without hidden courses.
  34
  35 === 3.7 ===
  36
  37  * The course pattern function in course_summary_exporter::get_course_pattern has been moved to $OUTPUT->get_generated_image_for_id.
  38  * The course color function in course_summary_exporter::coursecolor has been moved to $OUTPUT->get_generated_color_for_id.
  39  * External function core_course_external::get_course_contents new returns the following additional completiondata field:
  40    - valueused (indicates whether the completion state affects the availability of other content)
  41  * External function core_course_external::get_course_contents now returns a new contentsinfo field with summary files information.
  42  * External function core_course_external::get_course_contents now returns an additional field "tags" returning the content tags.
  43
  44 === 3.6 ===
  45
  46  * External function core_course_external::get_course_public_information now returns the roles and the primary role of course
  47    contacts.
  48  * External function core_course_external::get_course_contents now return the following additional file fields:
  49    - onclick (onclick javascript action code)
  50    - afterlink (after link info to be displayed)
  51    - customdata (module custom data (JSON encoded))
  52    - completion (to indicate if completion is enabled or not)
  53    - completiondata (completion status for the current user in the module)
  54  * External function core_group_external::get_course_user_groups now can return all user courses group information.
  55
  56 === 3.5 ===
  57
  58  * There is a new capability 'moodle/course:setforcedlanguage' to control which users can force the course
  59    language; create_course and update_course functions delegate access control to the caller code; if you
  60    are calling those functions you may be interested in checking if the logged in user has 'moodle/course:setforcedlanguage' capability.
  61
  62 === 3.3 ===
  63
  64  * External function core_course_external::get_courses_by_field now returns the course filters list and status.
  65  * External function core_course_external::get_courses_by_field now returns the end date of the course.
  66  * External function core_course_external::get_course_contents now return the following additional file fields:
  67    - mimetype (the file mime type)
  68    - isexternalfile (if is a file reference to a external repository)
  69    - repositorytype (the repository name in case is a external file)
  70    Those fields are VALUE_OPTIONAL for backwards compatibility.
  71  * External function core_course_external::get_course_contents now return the following fields for section and modules:
  72    - uservisible (whether the section or module is visible by the user)
  73    - availabilityinfo (availability information if the course or module has any access restriction set
  74
  75 === 3.2 ===
  76
  77  * External function core_course_external::get_course_contents now returns the section's number in the course (new section field).
  78  * External function core_course_external::get_course_contents now returns if a section is hidden in the course format.
  79  * External functions that were returning file information now return the following file fields:
  80    filename, filepath, mimetype, filesize, timemodified and fileurl.
  81    Those fields are now marked as VALUE_OPTIONAL for backwards compatibility.
  82  * The modchooser now uses a renderable and a template, thus its associated renderer
  83    methods have been deprecated. Note that the call to core_course_render::course_modchooser,
  84    is still required. Deprecated methods:
  85    - core_course_renderer::course_modchooser_module_types
  86    - core_course_renderer::course_modchooser_module
  87    - core_course_renderer::course_modchooser_title
  88  * You can now specify a course end date when calling core_course_external::create_courses and core_course_external::update_courses
  89    external functions. core_course_external::get_courses external function is now returning courses end date values.