[Summary view] [Print] [Text view]

   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  === 2.8 ===
   6  * The activity chooser now uses M.course.format.get_sectionwrapperclass()
   7    to determine the section selector, rather than a hard-coded `li.section`.
   8  * Activity duplication in /course/modduplicate.php is deprecated and is now done in /course/mod.php.  Deprecated calls will be honored by
   9    redirecting to /course/mod.php for 3rd party plugin support.
  10  * New method format_base::section_get_available_hook() allows plugins to override section availability.
  11  
  12  === 2.7 ===
  13  * The ->testedbrowsers array no longer needs to be defined in supports_ajax().
  14  * format_section_renderer_base::section_hidden has an new second optional argument $courseorid.
  15    If provided the section name is printed in the not available string when displaying the hidden section.
  16  
  17  === 2.6 ===
  18  
  19  * core_course_renderer::course_section_cm_edit_actions has two new optional arguments and now uses and action_menu component.
  20  * core_course_renderer::course_section_cm has been altered to call core_course_renderer::course_section_cm_edit_actions with the two new arguments
  21  * An additional course renderer function has been created which allows you to
  22    specify the wrapper for a course module within a section (e.g. the <li>).  This can be
  23    found in core_course_renderer::course_section_cm_list_item().
  24  
  25  === 2.5 ===
  26  
  27  * Functions responsible for output in course/lib.php are deprecated, the code is moved to
  28    appropriate renderers: print_section(), print_section_add_menus(), get_print_section_cm_text(),
  29    make_editing_buttons()
  30    See functions' phpdocs in lib/deprecatedlib.php
  31  * Function get_print_section_cm_text() is deprecated, replaced with methods in cm_info
  32  
  33  === 2.4 ===
  34  
  35  Course format API has been changed significantly. Instead of implementing callbacks course formats
  36  may overwrite the class format_base. See format_legacy class for a template for upgrading course
  37  format.
  38  
  39  * Function settings_navigation::add_course_editing_links() is completely removed, course format
  40    functions callback_XXXX_request_key() are no longer used (where XXXX is the course format name)
  41  * functions get_generic_section_name(), get_all_sections(), add_mod_to_section(), get_all_mods()
  42    are deprecated. See their phpdocs in lib/deprecatedlib.php on how to replace them
  43  * Course formats may now have their settings.php file as the most of other plugin types
  44  * Function format_section_renderer_base::is_section_current() is deprecated, overwrite/use
  45    function is_section_current in format class
  46  
  47  === 2.3 ===
  48  
  49  * The new $course->coursedisplay option was introduced, users can now choose to display
  50    a section at a time if the course formats support it:
  51   - COURSE_DISPLAY_SINGLEPAGE indicates the teacher has chosen to display all sections on one page
  52   - COURSE_DISPLAY_MULTIPAGE indicates the teacher has chose to have seperate pages with each section.
  53  
  54  * The parameter for 'currently active section' was standardised in core:
  55    - The course format is passed the currently live section through the $displaysection varaible to format.php
  56    - A 'section' paramter is the standardised way to pass around the current section in a course
  57    - Navigation no longer looks for custom parameters defined in callback_format_request_key