mirror of
https://github.com/moodle/moodle.git
synced 2025-02-08 17:11:49 +01:00
60cf074239
Creates a new method of handling all the section related icons. Including a new method that places these actions in a menu for topic and weeks course formats. (This version replaces "Edit" with "Topic/Week/or Section menu")
67 lines
3.8 KiB
Plaintext
67 lines
3.8 KiB
Plaintext
This files describes API changes for course formats
|
|
|
|
Overview of this plugin type at http://docs.moodle.org/dev/Course_formats
|
|
|
|
=== 3.0 ===
|
|
* Course formats should now use section_edit_control_items and use the returned array of controls items and their attributes to create a
|
|
renderable menu or array of links. Plugin calls to section_edit_controls will now include the section edit control in the returned array.
|
|
|
|
=== 2.9 ===
|
|
* Course formats may support deleting sections, see MDL-10405 for more details.
|
|
format_section_renderer_base::section_edit_controls() is now also called for
|
|
stealth sections and it also returns "delete" control.
|
|
|
|
=== 2.8 ===
|
|
* The activity chooser now uses M.course.format.get_sectionwrapperclass()
|
|
to determine the section selector, rather than a hard-coded `li.section`.
|
|
* Activity duplication in /course/modduplicate.php is deprecated and is now done in /course/mod.php. Deprecated calls will be honored by
|
|
redirecting to /course/mod.php for 3rd party plugin support.
|
|
* New method format_base::section_get_available_hook() allows plugins to override section availability.
|
|
|
|
=== 2.7 ===
|
|
* The ->testedbrowsers array no longer needs to be defined in supports_ajax().
|
|
* format_section_renderer_base::section_hidden has an new second optional argument $courseorid.
|
|
If provided the section name is printed in the not available string when displaying the hidden section.
|
|
|
|
=== 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
|