MDL-67183 question engine: allow lazy-init of question_attempts
[moodle.git] / question / engine / upgrade.txt
1 This files describes API changes for the core question engine.
3 === 3.9 ===
5 1) In the past, whenever a question_usage_by_activity was loaded from the database,
6    the apply_attempt_state was immediately called on every question, whether the
7    results of doing that were ever used, or not.
9    Now we have changed the code flow, so that apply_attempt_state is only called
10    when some data or processing is requested (e.g. analysing a response or rendering
11    the question) which requires the question to be fully initialised. This is MDL-67183.
13    This change should be completely invisible with everything handled by the question
14    engine. If you don't change your code, it should continue to work.
16    However, to get the full advantage of this change, you should review your code,
17    and look at every call to get_question or get_behaviour (on a question_attempt or
18    question_usage_by_activity). The problem with these methods is that the question engine
19    cannot know what you are planning to do with the question once you have got it.
20    Therefore, they have to assume that apply_attempt_state must be called - which can be expensive.
21    If you know that you don't need that (because, for example, you are just going to
22    look at ->id or ->questiontext or something simple) then you should pass
23    false to these functions, to get the possible performance benefit.
24    In addition, there is a new method $qa->get_question_id() to handle that case more simply.
27 === 3.7 ===
29 1) When a question is rendered, the outer div of the question has an id="q123"
30    added. Unfortunately, this id was not actually unique, leading to bugs like
31    MDL-52572. Therefore, we have had to change it. The id used now is what
32    is returned by the new method $qa->get_outer_question_div_unique_id().
33    The old code that you need to search for and replace with a call to this
34    method is "'q' . $qa->get_slot()"
36    Note, the new method has also been added to Moodle 3.5.6 and 3.6.4, but
37    returning the old id. This is to help question types that want to support
38    multiple Moodle versions.
40 === 3.1, 3.0.3, 2.9.5 ===
42 1) The field question_display_options::$extrainfocontent is now displayed in the
43    outcomes (yellow) div by default. It used to be in the info div. If you have
44    overriden the question renderer, you may need to make a corresponding change.
47 === 3.0, 2.9.2, 2.8.8 ===
49 1) The extra internal PARAM constant question_attempt::PARAM_MARK should no
50    longer be used. (It should not have been used outside the core of the
51    question system). See MDL-51090 if you want more explanation.
54 === 2.9 ===
56 1) Some new methods on the question_usage class (and corresponding methods on
57    question_attempt, question_attempt_step, question_usage_observer, ... requried
58    to implement them, but almost certainly you should only be calling the
59    question_usage methods from your code.
61    * question_usage::add_question_in_place_of_other($slot, $question, $maxmark = null)
63      This creates a new questoin_attempt in place of an existing one, moving the
64      existing question_attempt to the end of the usage, in a new slot number.
65      The new slot number is returned. The goal is to replace the old attempt, but
66      not lose the old data.
68    * question_usage::set_question_max_mark($slot, $maxmark)
70      Sets the max mark for one question in this usage. Previously, you could
71      only change this using the bulk operation question_usage::set_max_mark_in_attempts;
73    * question_usage::set_question_attempt_metadata($slot, $name, $value);
74      question_usage::get_question_attempt_metadata($slot, $name);
76      You can now record metadata, that is, values stored by name, against
77      question_attempts. The question engine ignores this data (other than storing
78      and loading it) but you may find it useful in your code.
80    To see examples of where these are used, look at the chagnes from MDL-40992.
82 2) New fields in question_display_options, ->extrainfocontent and ->extrahistorycontent.
83    These default to blank, but can be used to inject extra content into those parts
84    of the question display. If you have overridden the methods in
85    core_question_renderer that use these fields, you may need to update your renderer.
88 === 2.6 ===
90 1) The method question_behaviour::is_manual_grade_in_range and move and become
91    question_engine::is_manual_grade_in_range.
93 2) The arguments to core_question_renderer::mark_summary changed from
94    ($qa, $options) to ($qa, $behaviouroutput, $options). If you have overridden
95    that method you will need to update your code.
97 3) Heading level for number(), add_part_heading() and respond_history()
98    has been lowered by one level. These changes are part of improving the page
99    accessibility and making heading to have proper nesting. (MDL-41615)
101 === Earlier changes ===
103 * Were not documented in this way. Sorry.