course/upgrade.txt

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