course/format/upgrade.txt

   1 This files describes API changes for course formats
   2
   3 Overview of this plugin type at http://docs.moodle.org/dev/Course_formats
   4
   5 === 3.3 ===
   6 * Javascript code for editing activities and sections was moved to an AMD module, course/rest.php is no longer
   7   responsible for editing actions, instead it is done in web services. Carefully test all editing actions during upgrade.
   8 * The new method format_base::allow_stealth_module_visibility() can indicate whether course format supports "stealth"
   9   activities mode when they are available but not visible on course page. Course format that supports stealth mode
  10   must check $cm->is_visible_on_course_page() when displaying activities list on the course page instead of $cm->uservisible.
  11   For all other plugins except course formats the same property $cm->uservisible indicates if the activity contents
  12   is actually available to student.
  13 * Option "Number of sections" (numsections) was removed from topics and weeks formats, instead the actual number of records
  14   in the course_sections table is treated as a number of sections (excluding section 0 that should always be present).
  15 * Method create_course() will populate the new course with empty sections if $data->numsections is provided even if
  16   "numsections" is not an option defined by the course format.
  17 * course/changenumsections.php can now be used to insert sections at any positions.
  18 * The variable SECTIONLEFTSIDE was changed from '.left .section-handle img' to '.left .section-handle .icon' in
  19   course/format/topics/format.js and course/format/weeks/format.js due to the introduction of Font Awesome (see MDL-40759)
  20   which altered the HTML. Please check if your course format relies on this selector, and if so, update it.
  21
  22 === 3.2 ===
  23 * Callback delete_course is deprecated and should be replaced with observer for event \core\event\course_content_deleted
  24 * Course formats can overwrite get_default_course_enddate function to set the default course end date for new courses.
  25   format_base::get_default_course_enddate uses the new "Course duration" site setting to calculate the default course end date
  26   from the default course start date.
  27 * New method format_base::supports_news() which is used to determine whether an Announcements forum will be automatically created on
  28   course creation. For course format plugin developers, please override format_base::supports_news() to return true if you want the
  29   Announcements forum to be created upon course creation and remove the block names defined in format_base::get_default_blocks().
  30
  31 === 3.1 ===
  32 * Course format may use the inplace_editable template to allow quick editing of section names, see
  33   https://docs.moodle.org/dev/Inplace_editable and MDL-51802 for example implementation.
  34
  35 === 3.0 ===
  36 * Course formats should now use section_edit_control_items and use the returned array of controls items and their attributes to create a
  37   renderable menu or array of links.  Plugin calls to section_edit_controls will now include the section edit control in the returned array.
  38 * The section name is now wrapped in a new span (.sectionname > span), process_sections method in format.js should be updated so .sectionname
  39   DOM node's wraps the section title in a span. You can look at how to implement the change in course/format/topics/format.js or MDL-48947.
  40 * New method format_base::get_default_section_name retrieves the default section name for the given course format. The base
  41   implementation basically uses the implementation of format_base::get_section_name. The method can be overridden in
  42   format_base subclasses that use sections (i.e. format_topics, format_weeks). In relation to the changes made for the default
  43   section name, the default section name is now being shown when editing the section information.
  44
  45 === 2.9 ===
  46 * Course formats may support deleting sections, see MDL-10405 for more details.
  47   format_section_renderer_base::section_edit_controls() is now also called for
  48   stealth sections and it also returns "delete" control.
  49
  50 === 2.8 ===
  51 * The activity chooser now uses M.course.format.get_sectionwrapperclass()
  52   to determine the section selector, rather than a hard-coded `li.section`.
  53 * Activity duplication in /course/modduplicate.php is deprecated and is now done in /course/mod.php.  Deprecated calls will be honored by
  54   redirecting to /course/mod.php for 3rd party plugin support.
  55 * New method format_base::section_get_available_hook() allows plugins to override section availability.
  56
  57 === 2.7 ===
  58 * The ->testedbrowsers array no longer needs to be defined in supports_ajax().
  59 * format_section_renderer_base::section_hidden has an new second optional argument $courseorid.
  60   If provided the section name is printed in the not available string when displaying the hidden section.
  61
  62 === 2.6 ===
  63
  64 * core_course_renderer::course_section_cm_edit_actions has two new optional arguments and now uses and action_menu component.
  65 * core_course_renderer::course_section_cm has been altered to call core_course_renderer::course_section_cm_edit_actions with the two new arguments
  66 * An additional course renderer function has been created which allows you to
  67   specify the wrapper for a course module within a section (e.g. the <li>).  This can be
  68   found in core_course_renderer::course_section_cm_list_item().
  69
  70 === 2.5 ===
  71
  72 * Functions responsible for output in course/lib.php are deprecated, the code is moved to
  73   appropriate renderers: print_section(), print_section_add_menus(), get_print_section_cm_text(),
  74   make_editing_buttons()
  75   See functions' phpdocs in lib/deprecatedlib.php
  76 * Function get_print_section_cm_text() is deprecated, replaced with methods in cm_info
  77
  78 === 2.4 ===
  79
  80 Course format API has been changed significantly. Instead of implementing callbacks course formats
  81 may overwrite the class format_base. See format_legacy class for a template for upgrading course
  82 format.
  83
  84 * Function settings_navigation::add_course_editing_links() is completely removed, course format
  85   functions callback_XXXX_request_key() are no longer used (where XXXX is the course format name)
  86 * functions get_generic_section_name(), get_all_sections(), add_mod_to_section(), get_all_mods()
  87   are deprecated. See their phpdocs in lib/deprecatedlib.php on how to replace them
  88 * Course formats may now have their settings.php file as the most of other plugin types
  89 * Function format_section_renderer_base::is_section_current() is deprecated, overwrite/use
  90   function is_section_current in format class
  91
  92 === 2.3 ===
  93
  94 * The new $course->coursedisplay option was introduced, users can now choose to display
  95   a section at a time if the course formats support it:
  96  - COURSE_DISPLAY_SINGLEPAGE indicates the teacher has chosen to display all sections on one page
  97  - COURSE_DISPLAY_MULTIPAGE indicates the teacher has chose to have seperate pages with each section.
  98
  99 * The parameter for 'currently active section' was standardised in core:
 100   - The course format is passed the currently live section through the $displaysection varaible to format.php
 101   - A 'section' paramter is the standardised way to pass around the current section in a course
 102   - Navigation no longer looks for custom parameters defined in callback_format_request_key