mirror of
https://github.com/moodle/moodle.git
synced 2025-01-19 06:18:28 +01:00
46 lines
2.5 KiB
Plaintext
46 lines
2.5 KiB
Plaintext
This files describes API changes for course formats
|
|
|
|
Overview of this plugin type at http://docs.moodle.org/dev/Course_formats
|
|
|
|
=== 2.6 ===
|
|
|
|
* core_course_renderer::course_section_cm_edit_actions has two new optional arguments and now uses and action_menu component.
|
|
* core_course_renderer::course_section_cm has been altered to call core_course_renderer::course_section_cm_edit_actions with the two new arguments
|
|
* An additional course renderer function has been created which allows you to
|
|
specify the wrapper for a course module within a section (e.g. the <li>). This can be
|
|
found in core_course_renderer::course_section_cm_list_item().
|
|
|
|
=== 2.5 ===
|
|
|
|
* Functions responsible for output in course/lib.php are deprecated, the code is moved to
|
|
appropriate renderers: print_section(), print_section_add_menus(), get_print_section_cm_text(),
|
|
make_editing_buttons()
|
|
See functions' phpdocs in lib/deprecatedlib.php
|
|
* Function get_print_section_cm_text() is deprecated, replaced with methods in cm_info
|
|
|
|
=== 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)
|
|
* functions get_generic_section_name(), get_all_sections(), add_mod_to_section(), get_all_mods()
|
|
are deprecated. See their phpdocs in lib/deprecatedlib.php on how to replace them
|
|
* Course formats may now have their settings.php file as the most of other plugin types
|
|
* Function format_section_renderer_base::is_section_current() is deprecated, overwrite/use
|
|
function is_section_current in format class
|
|
|
|
=== 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
|