MDL-65050 core: add question_stats_cleanup_task scheduled task
[moodle.git] / question / upgrade.txt
CommitLineData
181393aa
TH
1This files describes API changes for code that uses the question API.
2
48aad79a
JMV
3=== 3.7 ===
4
5The code for the is_valid_number function that was duplicated in the
ebdd3450 6qtype_numerical and qtype_multianswer plugins in the qtype_numerical_edit_form
48aad79a
JMV
7and qtype_multianswer_edit_form classes has been moved to a static function
8in the qtype_numerical class of the qtype_numerical plugin.
9
5dd1cf33
JMV
10The exportprocess function of the qformat_default class doesn't output a blank line
11if the result of the writequestion function is null. This permit to qformat plugins
12to ignore some questions without the need to overwrite this function.
13
cc98914e
AN
14=== 3.5 ===
15
161) The question format exportprocess function now adds a
17 $checkcapabilities boolean to allow questions to be exported in
18 certain circumstances.
19
891750bc
FM
20=== 3.2 ===
21
221) The following renderers have been deprecated in favour of the renderable
23 core_question\output\qbank_chooser and associated render_* method.
24 * qbank_chooser
25 * qbank_chooser_types
26 * qbank_chooser_qtype
27 * qbank_chooser_title
28
5aeba199
DP
29=== 3.1 ===
30
311) The argument $requirecourseid was removed from question_edit_setup() and
32 is no longer respected. The behaviour was found to be buggy and now throws
33 debugging notices if passed.
34
4c3c1b51
TH
35=== 2.9 ===
36
1b49f31d
TH
371) Some functions in questionlib.php which were deprecated in the past have now
38 been deleted:
4c3c1b51
TH
39
40 Deprecated since 2.1
41 * question_list_instances
42 * get_grade_options
43 * question_category_isused
44 * save_question_options
45 * question_get_real_state
46
1b49f31d
TH
47 Deprecated since 2.6
48 * question_rewrite_questiontext_preview_urls
49 * question_send_questiontext_file
50 * question_pluginfile no longer falls back to using the old
51 {$previewcomponent}_questiontext_preview_pluginfile callback if the new
52 {$previewcomponent}_question_preview_pluginfile callback is missing.
53
4c3c1b51 54
16e246ac
TH
55=== 2.8 ===
56
f6579bea 571) This is just a warning that some methods of the question_engine_data_mapper
16e246ac
TH
58 class have changed. All these methods are ones that you should not have been
59 calling directly from your code, so this should not cause any problems.
60 The changed methods are:
61 * insert_question_attempt
62 * insert_step_data
63 * update_question_attempt_step
64
65
efa5155a
RM
66=== 2.7 ===
67
681) Changes to class question_bank_view:
69
70 Filters, including $recurse and $showhidden, are now implemented as
d62382d1 71 pluggable \core_question\bank\search\condition classes.
efa5155a
RM
72
73 Therefore $recurse and $showhidden are no longer passed to the following functions:
74 protected function display_options [deprecated, use display_options_form()]
75 protected function build_query_sql [deprecated, use build_query()]
76
d62382d1 77 protected function display_category_form() is deprecated. Use \core_question\bank\search\category_condition
efa5155a 78
d62382d1 79 protected function display_category_form_checkbox deprecated use html_writer::checkbox and separate JavaScript
efa5155a
RM
80
81To add filters, local plugins can now implement the function local_[pluginname]_get_question_bank_search_conditions,
82
17f229fa
RM
832) To make columns available to question_bank_view, plugins can extend core_question\bank\column_base.
84 Users may choose to display additional columns by setting $CFG->questionbankcolumns to a comma-delimited list of columns.
85
863) The subsort separator has changed from _ to - in order to distinuguish subsorts vs frankenstyle component separators.
87
884) Because of the move to autoloading, $knowncolumntypes and known_field_types() are no longer used.
89
905) question_bank_column_base and it's derived classes have been namespaced to core_question\bank\column_base.
d62382d1 91
16e246ac 92
181393aa
TH
93=== 2.6 ===
94
b07ef13b
DP
951) Modules using the question bank MUST now declare their use of it with the xxx_supports()
96 flag FEATURE_USES_QUESTIONS. question_module_uses_questions() should be used to determine
97 if a module uses questions.
98
992) It is sometimes necessary to display bits of question content without having
181393aa
TH
100 and attempt (question_usage) in progress. Two examples of this are the option
101 in the question bank to display the questiontext, and in the quiz statistics
102 report, where it displays the question text above the report.
103
104 Previously, this display was done using a special method that only worked for
105 the question text, but which would not work for other parts of the question.
106 That old mechanism has been deprecated, and there is a new method that you
107 should use.
108
109 To display the question, replace calls to question_rewrite_questiontext_preview_urls
110 with calls to question_rewrite_question_preview_urls. Because the new function
111 is more flexibile, you have to pass more arguments.
112
113 To perform the necessary permission checks when the file is downloaded, you need
114 to implement the callback [component name]_question_preview_pluginfile.
115 (Previously you implemented [component name]_questiontext_preview_pluginfile.)
116 quiz_statistics_question_preview_pluginfile is an example of what to do.
117
118 question_send_questiontext_file has been deprecated. It is no longer necessary.
119
120 To ensure you are no longer using or defining any deprecated functions,
121 search for the regular expression:
122 question_rewrite_questiontext_preview_urls|_questiontext_preview_pluginfile|question_send_questiontext_file
70f22d60 123
c2f35e0b
TH
1243) The argument list for core_question_renderer::mark_summary has changed.
125 Please update your calls. (The most likely scenario for this is if you have
126 overridden core_question_renderer::info in your own renderer.) You need to
127 make a change like:
128 - $this->mark_summary($qa, $options);
129 + $this->mark_summary($qa, $behaviouroutput, $options);