moodle/course/format/upgrade.txt
Marina Glancy ee7084e950 MDL-35263 Converting course formats to OOP
- added class format_base as the base for all course formats
- added class format_site for the pseudo-format 'site' used for displaying activities on the front page
- added class format_legacy that overrides format_base functions with calling old-style 'callback_xxx' functions
- replaced all usage of 'callback_xxx' functions with format_base methods
- made arguments of get_section_name(), get_course_url() more flexible
- deprecated function get_generic_section_name(), it's contents is moved to format_base
- global_navigation::format_display_course_content() is removed, plugins can supress the sections navigations using extend_course_navigation()
2012-09-28 13:42:27 +08:00

24 lines
1.2 KiB
Text

This files describes API changes for course formats
Overview of this plugin type at http://docs.moodle.org/dev/Course_formats
=== 2.4 ===
Course format API has been changed significantly. Instead of implementing callbacks course formats
may overwrite the class format_base. See format_legacy class for a template for upgrading course
format.
* Function settings_navigation::add_course_editing_links() is completely removed, course format
functions callback_XXXX_request_key() are no longer used (where XXXX is the course format name)
=== 2.3 ===
* The new $course->coursedisplay option was introduced, users can now choose to display
a section at a time if the course formats support it:
- COURSE_DISPLAY_SINGLEPAGE indicates the teacher has chosen to display all sections on one page
- COURSE_DISPLAY_MULTIPAGE indicates the teacher has chose to have seperate pages with each section.
* The parameter for 'currently active section' was standardised in core:
- The course format is passed the currently live section through the $displaysection varaible to format.php
- A 'section' paramter is the standardised way to pass around the current section in a course
- Navigation no longer looks for custom parameters defined in callback_format_request_key