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