Merge branch 'MDL-65255-master' of git://github.com/jleyva/moodle
[moodle.git] / question / engine / upgrade.txt
1 This files describes API changes for the core question engine.
3 === 3.7 ===
5 1) When a question is rendered, the outer div of the question has an id="q123"
6    added. Unfortunately, this id was not actually unique, leading to bugs like
7    MDL-52572. Therefore, we have had to change it. The id used now is what
8    is returned by the new method $qa->get_outer_question_div_unique_id().
9    The old code that you need to search for and replace with a call to this
10    method is "'q' . $qa->get_slot()"
12    Note, the new method has also been added to Moodle 3.5.6 and 3.6.4, but
13    returning the old id. This is to help question types that want to support
14    multiple Moodle versions.
16 === 3.1, 3.0.3, 2.9.5 ===
18 1) The field question_display_options::$extrainfocontent is now displayed in the
19    outcomes (yellow) div by default. It used to be in the info div. If you have
20    overriden the question renderer, you may need to make a corresponding change.
23 === 3.0, 2.9.2, 2.8.8 ===
25 1) The extra internal PARAM constant question_attempt::PARAM_MARK should no
26    longer be used. (It should not have been used outside the core of the
27    question system). See MDL-51090 if you want more explanation.
30 === 2.9 ===
32 1) Some new methods on the question_usage class (and corresponding methods on
33    question_attempt, question_attempt_step, question_usage_observer, ... requried
34    to implement them, but almost certainly you should only be calling the
35    question_usage methods from your code.
37    * question_usage::add_question_in_place_of_other($slot, $question, $maxmark = null)
39      This creates a new questoin_attempt in place of an existing one, moving the
40      existing question_attempt to the end of the usage, in a new slot number.
41      The new slot number is returned. The goal is to replace the old attempt, but
42      not lose the old data.
44    * question_usage::set_question_max_mark($slot, $maxmark)
46      Sets the max mark for one question in this usage. Previously, you could
47      only change this using the bulk operation question_usage::set_max_mark_in_attempts;
49    * question_usage::set_question_attempt_metadata($slot, $name, $value);
50      question_usage::get_question_attempt_metadata($slot, $name);
52      You can now record metadata, that is, values stored by name, against
53      question_attempts. The question engine ignores this data (other than storing
54      and loading it) but you may find it useful in your code.
56    To see examples of where these are used, look at the chagnes from MDL-40992.
58 2) New fields in question_display_options, ->extrainfocontent and ->extrahistorycontent.
59    These default to blank, but can be used to inject extra content into those parts
60    of the question display. If you have overridden the methods in
61    core_question_renderer that use these fields, you may need to update your renderer.
64 === 2.6 ===
66 1) The method question_behaviour::is_manual_grade_in_range and move and become
67    question_engine::is_manual_grade_in_range.
69 2) The arguments to core_question_renderer::mark_summary changed from
70    ($qa, $options) to ($qa, $behaviouroutput, $options). If you have overridden
71    that method you will need to update your code.
73 3) Heading level for number(), add_part_heading() and respond_history()
74    has been lowered by one level. These changes are part of improving the page
75    accessibility and making heading to have proper nesting. (MDL-41615)
77 === Earlier changes ===
79 * Were not documented in this way. Sorry.