MDL-66553 questions: add $CFG->questionbankcolumns to config-dist.php
[moodle.git] / question / type / upgrade.txt
CommitLineData
78fc17eb
TH
1This files describes API changes for question type plugins.
2
94cb5a66 3=== 3.5 ===
5a8d683f
NN
4 + Added new classes backup_qtype_extrafields_plugin and restore_qtype_extrafields_plugin
5 in order to use extra fields method in backup/restore question type. Require and inherit new classes for using it. See
6 backup_qtype_shortanswer_plugin and restore_qtype_shortanswer_plugin for an example of using this.
94cb5a66
LB
7 + The declaration of is_gradable_response has been moved from question_automatically_gradable to
8 question_manually_gradable.
9 + The default implementation of is_gradable_response has been moved from question_graded_automatically to
10 question_with_responses.
b197da87
MG
11 + Note that format_text() is no longer applied to the results of
12 qtype_elements_embedded_in_question_text_renderer::embedded_element(). If question type overrides
13 this method make sure you apply format_text() to any text that came from a user.
5a8d683f 14
c28bfbef
TH
15=== 3.1.5, 3.2.2, 3.3 ===
16
17* If you are using check_combined_feedback_file_access in your check_file_access method,
18 then you must now pass $args as the 4th argument, so the correct permission checks
19 can be performed. If you don't, you will get a developer debug notice.
20
1405f010
EL
21=== 3.1 ===
22
23* The following functions, previously used (exclusively) by upgrade steps are not available
24 anymore because of the upgrade cleanup performed for this version. See MDL-51580 for more info:
25 - qtype_essay_convert_to_html()
26
3d6f2466
JP
27=== 2.7 ===
28 + We have added a new method to the question_type base class 'break_down_stats_and_response_analysis_by_variant'. By default it
29 returns true. If your question type does not have variants of question instances then you can ignore this method as it only
30 applies to question types that have variants. If a question type does have variants the default action is to break down
31 response analysis and question stats by variant. But for some question types there might be an almost infinite quantity of
32 variants for the question, in this case you can suppress break down by variant by returning false from this method. See for
33 example the non-core question type varnumeric or the slightly more complex stack question type.
58794ac9
JP
34 + We have added a pair of methods to the question_definition class 'prepare_simulated_post_data' and
35 'get_student_response_values_for_simulation'. You may want to override these methods in question.php in your question type plug
36 -in. These methods are used to convert data from a csv file of simulated step data into the simulated post data that is fed
37 to the question engine. These csv files can be used for unit testing or manual testing the use of your question type within the
38 quiz module. You can use the simulate quiz report for manual testing and also to easily generate csv test files. You can
39 run a number of students through a test and then download a csv file representing their interaction with the quiz. For most
40 question types the default of just passing csv data as post data, directly from the csv file will probably work fine. But for
41 certain question types where the meaning of the post data is deliberately obfuscated it might be necessary to convert from a
42 human friendly format in the csv file to response data expected by the question type using 'prepare_simulated_post_data' and
43 to convert back from a question type response array to values for download in a csv file using
44 'get_student_response_values_for_simulation'.
0c0dfa8f
DW
45=== 2.6 ===
46 + The changes in MDL-32750 were reverted in favour of the new pdw toggle toolbars
47 plugin for TinyMCE. The get_non_collapsible_editor_options method has been deprecated.
48
eca230b5
TH
49=== 2.5 ===
50
dc38c5b4 51* There have been some tweaks to the helper class that is used to write
eca230b5
TH
52 walkthrough tests. You should not have to change your code, but you might
53 like to take a look at some of the new helper methods available. In particular,
54 if you had any code that did
55 $this->process_submission(array('-finish' => 1));
56 you should change that to
57 $this->finish();
dc38c5b4
TH
58
59* There have been lots of usability improvements to the question editing forms.
60 MDL-37417 links to all the changes. There are only a few API changes that
61 *require* you to upgrade your question type, but you are strongly recommended
62 to make similar usability improvements in your own question types.
63
64 + Some of the ids used in the form HTML have had ‘id_’ added at the front.
65 Take care if you refer to these in your JavasSript or CSS.
66
67 + MDL-32750 The HTML editing tools are now collapsed. This is applied by default
68 to all HTML editors except question text and general feedback. If you want to
69 add more exceptions, see the get_non_collabsible_editor_options method.
70
71 + Form fields have been grouped onto one line where appropriate, to reduce
72 the height of the form. qtype_numerical is a good example of this.
73
74 + Where elements are in groups, we have changed the normal accesshide CSS, so
75 that their labels are visible. If you were using grouped elements in the past
76 with static elements to lable the fields, then you will need to remove the statics.
77
78 + All the choices / answers have been merged into a single section of the form.
79 This works better with the new 'shortforms' MDL-30637. Also the
80 "Add blanks for more ..." buttons are now inside that section. This probably
81 requries that you remove any headings from your per-answer fields, and change
82 some of the labels.
83
84 + Having merged all the elements into one form section, we then used CSS to
85 visually group the fields for one choice, answer, etc.
86
87 + When editing an existing question, we only show as many repeats are are
88 actually needed until the user clicks the "Add blanks for more ..." button.
89 Where you have your own repeat elements, you may need to change the
90 number of repeats calculation.
91
92 + As with all forms, setType() is now required for all text form elements.
93
94 + A good example of a question type being upgraded to take account of all these
95 changes is
96 https://github.com/moodleou/moodle-qtype_pmatch/commit/9d8e1beb9f780246416a0f3a7622f700b8fa90c8
97
eca230b5 98
e01cf1fa
TH
99=== 2.3.5 / 2.4.2 / 2.5 ===
100
101* The special value question_attempt::PARAM_CLEANHTML_FILES that could be used
102 in the get_expected_data method was renamed to question_attempt::PARAM_RAW_FILES
103 in order to fix a bug. We failed to think this throught, and so did not realised
104 that this might break some question types. If this affected your question type,
105 please accept our apologies. Details in MDL-37847.
106
107
a031b0f3 108=== 2.3 ===
c2f5e2ab 109
a031b0f3
TH
110* Support for backwards-compatible string names dropped. MDL-30120. (See under 2.2 below.)
111* If you are overriding export_to_xml and import_from_xml to provide Moodle XML format
112 import and export, then you will probably get PHP strict syntax notices in developer
113 debug mode until you change the method signature to include qformat_xml $format.
114 That is, you need to specify the argument type.
7a00d438
DM
115* qtype_xxx_pluginfile() is now given the 7th parameter (hopefully the last
116 one) that contains additional options for the file serving. The array should
117 be re-passed to question_pluginfile() as is.
c2f5e2ab
TH
118
119
78fc17eb
TH
120=== 2.2 ===
121
122* The XML import/export base class has had some minor API changes. The
123 - write_combined_feedback method now requires that you pass the questionid and
124 contextid. (MDL-29058)
125 - calls to the import_hints and import_answer methods now should pass the question
126 text format as the last argument, to be used as a default if necessary. (MDL-29739)
127 If you do not upgrade your code, it will not break, but there will be PHP
128 warnings, and it the export will not work 100% correctly.
129
226b3124
TH
130* The old
131 public function requires_qtypes()
132method is no more. Instead use the ->dependencies facility in version.php. E.g.
133$plugin->dependencies = array(
134 'qtype_numerical' => 2011102700,
135);
136
137* The plugin name and related strings used to be defined in language strings
138called the same thing as the format, for example:
139
140$string['addingdescription'] = 'Adding a Description';
141$string['description'] = 'Description';
142$string['description_help'] = 'A description is not really a question type. It simply enables text to be displayed without requiring any answers, similar to a label on the course page.
143$string['description_link'] = 'A description is not really a question type. It simply enables text to be displayed without requiring any answers, similar to a label on the course page.
144$string['descriptionsummary'] = 'This is not actually a question. Instead it is a way to add some instructions, rubric or other content to the activity. This is similar to the way that labels can be used to add content to the course page.';
145$string['editingdescription'] = 'Editing a Description';
146
147All these need to be changed to use the standard string name pluginname, as for
148other plugin types, and similar for the other strings.
149
150$string['pluginname'] = 'Description';
151$string['pluginname_help'] = 'A description is not really a question type. It simply enables text to be displayed without requiring any answers, similar to a label on the course page.
152$string['pluginname_link'] = 'A description is not really a question type. It simply enables text to be displayed without requiring any answers, similar to a label on the course page.
153$string['pluginnameadding'] = 'Adding a Description';
154$string['pluginnameediting'] = 'Editing a Description';
155$string['pluginnamesummary'] = 'This is not actually a question. Instead it is a way to add some instructions, rubric or other content to the activity. This is similar to the way that labels can be used to add content to the course page.';
156
157The old strings will continue to work, but only until Moodle 2.3 is released.
56565037
VS
158
159* If you are using the facilities provided by overriding the extra_answer_fields
160 or questionid_column_name methods, then you must change these to be public
161 methods. (This is required so that backup and restore can be made to work
162 automatically. MDL-24408, MDL-25617, MDL-30562)
0b94d6bf 163
0b94d6bf 164
a031b0f3
TH
165=== 2.1 ===
166
167* Lots of API changes due to the new question engine. See
168http://docs.moodle.org/dev/Developing_a_Question_Type#Converting_a_Moodle_2.0_question_type
169
170
171=== 2.0 ===
172
173* Lots of changes due to all the API changes in Moodle 2.0.
174
175* This plugin type now supports cron in the standard way. If required, Create a
176 lib.php file containing
177function qtype_mypluginname_cron() {};