fffbb93c55e43fdf8646bc84b7d049a867657fd1
[moodle.git] / course / format / upgrade.txt
1 This files describes API changes for course formats
3 Overview of this plugin type at http://docs.moodle.org/dev/Course_formats
5 === 2.7 ===
6 * The ->testedbrowsers array no longer needs to be defined in supports_ajax().
7 * format_section_renderer_base::section_hidden has an new second optional argument $courseorid.
8   If provided the section name is printed in the not available string when displaying the hidden section.
10 === 2.6 ===
12 * core_course_renderer::course_section_cm_edit_actions has two new optional arguments and now uses and action_menu component.
13 * core_course_renderer::course_section_cm has been altered to call core_course_renderer::course_section_cm_edit_actions with the two new arguments
14 * An additional course renderer function has been created which allows you to
15   specify the wrapper for a course module within a section (e.g. the <li>).  This can be
16   found in core_course_renderer::course_section_cm_list_item().
18 === 2.5 ===
20 * Functions responsible for output in course/lib.php are deprecated, the code is moved to
21   appropriate renderers: print_section(), print_section_add_menus(), get_print_section_cm_text(),
22   make_editing_buttons()
23   See functions' phpdocs in lib/deprecatedlib.php
24 * Function get_print_section_cm_text() is deprecated, replaced with methods in cm_info
26 === 2.4 ===
28 Course format API has been changed significantly. Instead of implementing callbacks course formats
29 may overwrite the class format_base. See format_legacy class for a template for upgrading course
30 format.
32 * Function settings_navigation::add_course_editing_links() is completely removed, course format
33   functions callback_XXXX_request_key() are no longer used (where XXXX is the course format name)
34 * functions get_generic_section_name(), get_all_sections(), add_mod_to_section(), get_all_mods()
35   are deprecated. See their phpdocs in lib/deprecatedlib.php on how to replace them
36 * Course formats may now have their settings.php file as the most of other plugin types
37 * Function format_section_renderer_base::is_section_current() is deprecated, overwrite/use
38   function is_section_current in format class
40 === 2.3 ===
42 * The new $course->coursedisplay option was introduced, users can now choose to display
43   a section at a time if the course formats support it:
44  - COURSE_DISPLAY_SINGLEPAGE indicates the teacher has chosen to display all sections on one page
45  - COURSE_DISPLAY_MULTIPAGE indicates the teacher has chose to have seperate pages with each section.
47 * The parameter for 'currently active section' was standardised in core:
48   - The course format is passed the currently live section through the $displaysection varaible to format.php
49   - A 'section' paramter is the standardised way to pass around the current section in a course
50   - Navigation no longer looks for custom parameters defined in callback_format_request_key