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