course/upgrade.txt

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