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