MDL-55797 output: Support form method in chooser
[moodle.git] / question / upgrade.txt
CommitLineData
181393aa
TH
1This files describes API changes for code that uses the question API.
2
5aeba199
DP
3=== 3.1 ===
4
51) The argument $requirecourseid was removed from question_edit_setup() and
6 is no longer respected. The behaviour was found to be buggy and now throws
7 debugging notices if passed.
8
4c3c1b51
TH
9=== 2.9 ===
10
1b49f31d
TH
111) Some functions in questionlib.php which were deprecated in the past have now
12 been deleted:
4c3c1b51
TH
13
14 Deprecated since 2.1
15 * question_list_instances
16 * get_grade_options
17 * question_category_isused
18 * save_question_options
19 * question_get_real_state
20
1b49f31d
TH
21 Deprecated since 2.6
22 * question_rewrite_questiontext_preview_urls
23 * question_send_questiontext_file
24 * question_pluginfile no longer falls back to using the old
25 {$previewcomponent}_questiontext_preview_pluginfile callback if the new
26 {$previewcomponent}_question_preview_pluginfile callback is missing.
27
4c3c1b51 28
16e246ac
TH
29=== 2.8 ===
30
f6579bea 311) This is just a warning that some methods of the question_engine_data_mapper
16e246ac
TH
32 class have changed. All these methods are ones that you should not have been
33 calling directly from your code, so this should not cause any problems.
34 The changed methods are:
35 * insert_question_attempt
36 * insert_step_data
37 * update_question_attempt_step
38
39
efa5155a
RM
40=== 2.7 ===
41
421) Changes to class question_bank_view:
43
44 Filters, including $recurse and $showhidden, are now implemented as
d62382d1 45 pluggable \core_question\bank\search\condition classes.
efa5155a
RM
46
47 Therefore $recurse and $showhidden are no longer passed to the following functions:
48 protected function display_options [deprecated, use display_options_form()]
49 protected function build_query_sql [deprecated, use build_query()]
50
d62382d1 51 protected function display_category_form() is deprecated. Use \core_question\bank\search\category_condition
efa5155a 52
d62382d1 53 protected function display_category_form_checkbox deprecated use html_writer::checkbox and separate JavaScript
efa5155a
RM
54
55To add filters, local plugins can now implement the function local_[pluginname]_get_question_bank_search_conditions,
56
17f229fa
RM
572) To make columns available to question_bank_view, plugins can extend core_question\bank\column_base.
58 Users may choose to display additional columns by setting $CFG->questionbankcolumns to a comma-delimited list of columns.
59
603) The subsort separator has changed from _ to - in order to distinuguish subsorts vs frankenstyle component separators.
61
624) Because of the move to autoloading, $knowncolumntypes and known_field_types() are no longer used.
63
645) question_bank_column_base and it's derived classes have been namespaced to core_question\bank\column_base.
d62382d1 65
16e246ac 66
181393aa
TH
67=== 2.6 ===
68
b07ef13b
DP
691) Modules using the question bank MUST now declare their use of it with the xxx_supports()
70 flag FEATURE_USES_QUESTIONS. question_module_uses_questions() should be used to determine
71 if a module uses questions.
72
732) It is sometimes necessary to display bits of question content without having
181393aa
TH
74 and attempt (question_usage) in progress. Two examples of this are the option
75 in the question bank to display the questiontext, and in the quiz statistics
76 report, where it displays the question text above the report.
77
78 Previously, this display was done using a special method that only worked for
79 the question text, but which would not work for other parts of the question.
80 That old mechanism has been deprecated, and there is a new method that you
81 should use.
82
83 To display the question, replace calls to question_rewrite_questiontext_preview_urls
84 with calls to question_rewrite_question_preview_urls. Because the new function
85 is more flexibile, you have to pass more arguments.
86
87 To perform the necessary permission checks when the file is downloaded, you need
88 to implement the callback [component name]_question_preview_pluginfile.
89 (Previously you implemented [component name]_questiontext_preview_pluginfile.)
90 quiz_statistics_question_preview_pluginfile is an example of what to do.
91
92 question_send_questiontext_file has been deprecated. It is no longer necessary.
93
94 To ensure you are no longer using or defining any deprecated functions,
95 search for the regular expression:
96 question_rewrite_questiontext_preview_urls|_questiontext_preview_pluginfile|question_send_questiontext_file
70f22d60 97
c2f35e0b
TH
983) The argument list for core_question_renderer::mark_summary has changed.
99 Please update your calls. (The most likely scenario for this is if you have
100 overridden core_question_renderer::info in your own renderer.) You need to
101 make a change like:
102 - $this->mark_summary($qa, $options);
103 + $this->mark_summary($qa, $behaviouroutput, $options);