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