MDL-47122 use insert_records to improve question engine performance.
[moodle.git] / question / upgrade.txt
CommitLineData
181393aa
TH
1This files describes API changes for code that uses the question API.
2
efa5155a
RM
3=== 2.7 ===
4
51) Changes to class question_bank_view:
6
7 Filters, including $recurse and $showhidden, are now implemented as
d62382d1 8 pluggable \core_question\bank\search\condition classes.
efa5155a
RM
9
10 Therefore $recurse and $showhidden are no longer passed to the following functions:
11 protected function display_options [deprecated, use display_options_form()]
12 protected function build_query_sql [deprecated, use build_query()]
13
d62382d1 14 protected function display_category_form() is deprecated. Use \core_question\bank\search\category_condition
efa5155a 15
d62382d1 16 protected function display_category_form_checkbox deprecated use html_writer::checkbox and separate JavaScript
efa5155a
RM
17
18To add filters, local plugins can now implement the function local_[pluginname]_get_question_bank_search_conditions,
19
17f229fa
RM
202) To make columns available to question_bank_view, plugins can extend core_question\bank\column_base.
21 Users may choose to display additional columns by setting $CFG->questionbankcolumns to a comma-delimited list of columns.
22
233) The subsort separator has changed from _ to - in order to distinuguish subsorts vs frankenstyle component separators.
24
254) Because of the move to autoloading, $knowncolumntypes and known_field_types() are no longer used.
26
275) question_bank_column_base and it's derived classes have been namespaced to core_question\bank\column_base.
d62382d1 28
181393aa
TH
29=== 2.6 ===
30
b07ef13b
DP
311) Modules using the question bank MUST now declare their use of it with the xxx_supports()
32 flag FEATURE_USES_QUESTIONS. question_module_uses_questions() should be used to determine
33 if a module uses questions.
34
352) It is sometimes necessary to display bits of question content without having
181393aa
TH
36 and attempt (question_usage) in progress. Two examples of this are the option
37 in the question bank to display the questiontext, and in the quiz statistics
38 report, where it displays the question text above the report.
39
40 Previously, this display was done using a special method that only worked for
41 the question text, but which would not work for other parts of the question.
42 That old mechanism has been deprecated, and there is a new method that you
43 should use.
44
45 To display the question, replace calls to question_rewrite_questiontext_preview_urls
46 with calls to question_rewrite_question_preview_urls. Because the new function
47 is more flexibile, you have to pass more arguments.
48
49 To perform the necessary permission checks when the file is downloaded, you need
50 to implement the callback [component name]_question_preview_pluginfile.
51 (Previously you implemented [component name]_questiontext_preview_pluginfile.)
52 quiz_statistics_question_preview_pluginfile is an example of what to do.
53
54 question_send_questiontext_file has been deprecated. It is no longer necessary.
55
56 To ensure you are no longer using or defining any deprecated functions,
57 search for the regular expression:
58 question_rewrite_questiontext_preview_urls|_questiontext_preview_pluginfile|question_send_questiontext_file
70f22d60 59
c2f35e0b
TH
603) The argument list for core_question_renderer::mark_summary has changed.
61 Please update your calls. (The most likely scenario for this is if you have
62 overridden core_question_renderer::info in your own renderer.) You need to
63 make a change like:
64 - $this->mark_summary($qa, $options);
65 + $this->mark_summary($qa, $behaviouroutput, $options);