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