course/upgrade.txt

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