Moodle release 3.3.8
[moodle.git] / mod / lesson / upgrade.txt
blob0f7def5ae42eb043ac6d602f1deb0da92e1feb57
1 This files describes API changes in the lesson code.
3 === 3.3.2 ===
5 * lesson_refresh_events() Now takes two additional parameters to refine the update to a specific instance. This function
6   now optionally takes the module instance object or ID, and the course module object or ID. Please try to send the full
7   objects instead of the ids to save DB calls.
9 === 3.3 ===
11 * lesson::callback_on_view() has an additional optional parameter $redirect default to true.
12   It can be set to false to avoid redirection and return the page to redirect.
13 === 3.1 ===
14 * Removed the unused file reformat.php
15 * removedoublecr() and importmodifiedaikenstyle() have now been removed.
17 === 3.0 ===
18 * Removed broken high score code.  Use the activity results block instead.
20 === 2.9 ===
21 * The  grade_item_delete function in mod/lesson/lib.php was removed because it was not doing anything and was never called.
22 * A third optional boolean parameter $endreached was added to lesson::update_timer to indicate that end of lesson was reached. This is used by 'completionendreached' custom completion rule.
23 * lesson_page_type_endofbranch::update in mod/lesson/pagetypes/endofbranch.php
24   and lesson_page_type_endofcluster::update in mod/lesson/pagetypes/endofcluster.php
25   have been removed, this is now handled by the base class: lesson_page::update in
26   locallib.php and the exact same code is executed (it is also executed by the
27   lesson_page_type_cluster class that previously had no update function).
28 * A fourth parameter (format) has been added to the add_answer() function
29   located as part of the lesson_add_page_form_base class. If specified with a value of 'LESSON_ANSWER_HTML'
30   then a rich html editor is generated. Otherwise an editor is created with Moodle Auto Format
31 * removedoublecr() and importmodifiedaikenstyle() are now deprecated.
32 * Added support for groups and groupings. If enabled, this allows the Report and
33   Grade Essay view to be filtered by a group
35 === Earlier changes ===
37 * Were not documented in this way. Sorry.