weekly release 4.0dev
[moodle.git] / question / type / upgrade.txt
1 This files describes API changes for question type plugins.
4 === 3.11 ===
5 * Introducing the following \question_type base class methods to save/fetch the last form values
6   that were used when creating questions as the new defaults when creating new questions:
7   - \question_type::get_default_value()
8     - Fetches the default value for a given question field from the user preference.
9       Question type plugins can use this in edit_{qtypename}_form.php when using $mform->setDefault().
10   - \question_type::set_default_value()
11     - Saves the default value for a given question form field in the user preferences.
12   - \question_type::save_defaults_for_new_questions()
13     - Saves the question type plugin's defined form defaults into the user preferences.
14       It calls \question_type::set_default_value() to save each form field default value
15       into the user preferences.
16     - Question type plugins using \question_type::get_default_value() for their form fields must implement
17       this in order to save the values from these form fields as defaults for new questions.
19   This will help teachers who repeatedly create questions and use the same values for the fields
20   (e.g. Default mark, Penalty for each incorrect try, etc.) in the question edit form.
22 === 3.8 ===
24 * There is a new method for question types get_extra_question_bank_actions.
25   Assuming the question bank display is using the new 'edit_menu_column'
26   (which it will be by default) this method lets you add question-type-specific
27   actions to the menu. The question_type base class has extensive PHPdoc comments
28   on the method to explain what you should do, and there is an example of how to
29   use it in a question type at
30   https://github.com/moodleou/moodle-qtype_pmatch/commit/2aefa8b5dcc7bab768f4707a4ffb7befcf4c2540.
32 === 3.8, 3.7.3, 3.6.7 ===
34 * Coming up in Moodle 3.8 are some changes to the question bank UI. These will break any
35   Behat automated tests which use the common pattern
36     When I click on "Duplicate" "link" in the "Test question" "table_row"
37   to trigger actions on questions when looking at the question bank screen. Therefore,
38   a new step has been introduced:
39     When I choose "Duplicate" action for "Test question" in the question bank
40   If you want your Behat tests to continue working with Moodle 3.8, you will need to use
41   the new step. The new step has been back-ported, so you can start updating your tests
42   and have them work with Moodle 3.6 and 3.7. In addition, if you want to trigger the
43   "Edit" action, you should change that to "Edit question".
46 === 3.5 ===
48   + Added new classes backup_qtype_extrafields_plugin and restore_qtype_extrafields_plugin
49    in order to use extra fields method in backup/restore question type. Require and inherit new classes for using it. See
50    backup_qtype_shortanswer_plugin and restore_qtype_shortanswer_plugin for an example of using this.
51   + The declaration of is_gradable_response has been moved from question_automatically_gradable to
52    question_manually_gradable.
53   + The default implementation of is_gradable_response has been moved from question_graded_automatically to
54    question_with_responses.
55   + Note that format_text() is no longer applied to the results of
56    qtype_elements_embedded_in_question_text_renderer::embedded_element(). If question type overrides
57    this method make sure you apply format_text() to any text that came from a user.
59 === 3.1.5, 3.2.2, 3.3 ===
61 * If you are using check_combined_feedback_file_access in your check_file_access method,
62   then you must now pass $args as the 4th argument, so the correct permission checks
63   can be performed. If you don't, you will get a developer debug notice.
65 === 3.1 ===
67 * The following functions, previously used (exclusively) by upgrade steps are not available
68   anymore because of the upgrade cleanup performed for this version. See MDL-51580 for more info:
69     - qtype_essay_convert_to_html()
71 === 2.7 ===
72   + We have added a new method to the question_type base class 'break_down_stats_and_response_analysis_by_variant'. By default it
73    returns true. If your question type does not have variants of question instances then you can ignore this method as it only
74    applies to question types that have variants. If a question type does have variants the default action is to break down
75    response analysis and question stats by variant. But for some question types there might be an almost infinite quantity of
76    variants for the question, in this case you can suppress break down by variant by returning false from this method. See for
77    example the non-core question type varnumeric or the slightly more complex stack question type.
78   + We have added a pair of methods to the question_definition class 'prepare_simulated_post_data' and
79   'get_student_response_values_for_simulation'. You may want to override these methods in question.php in your question type plug
80    -in. These methods are used to convert data from a csv file of simulated step data into the simulated post data that is fed
81    to the question engine. These csv files can be used for unit testing or manual testing the use of your question type within the
82    quiz module.  You  can use the simulate quiz report for manual testing and also to easily generate csv test files. You can
83    run a number of students through a test and then download a csv file representing their interaction with the quiz. For most
84    question types the default of just passing csv data as post data, directly from the csv file will probably work fine. But for
85    certain question types where the meaning of the post data is deliberately obfuscated it might be necessary to convert from a
86    human friendly format in the csv file to response data expected by the question type using 'prepare_simulated_post_data' and
87    to convert back from a question type response array to values for download in a csv file using
88    'get_student_response_values_for_simulation'.
89 === 2.6 ===
90   + The changes in MDL-32750 were reverted in favour of the new pdw toggle toolbars
91     plugin for TinyMCE. The get_non_collapsible_editor_options method has been deprecated.
93 === 2.5 ===
95 * There have been some tweaks to the helper class that is used to write
96   walkthrough tests. You should not have to change your code, but you might
97   like to take a look at some of the new helper methods available. In particular,
98   if you had any code that did
99   $this->process_submission(array('-finish' => 1));
100   you should change that to
101   $this->finish();
103 * There have been lots of usability improvements to the question editing forms.
104   MDL-37417 links to all the changes. There are only a few API changes that
105   *require* you to upgrade your question type, but you are strongly recommended
106   to make similar usability improvements in your own question types.
108   + Some of the ids used in the form HTML have had ‘id_’ added at the front.
109     Take care if you refer to these in your JavasSript or CSS.
111   + MDL-32750 The HTML editing tools are now collapsed. This is applied by default
112     to all HTML editors except question text and general feedback. If you want to
113     add more exceptions, see the get_non_collabsible_editor_options method.
115   + Form fields have been grouped onto one line where appropriate, to reduce
116     the height of the form. qtype_numerical is a good example of this.
118   + Where elements are in groups, we have changed the normal accesshide CSS, so
119     that their labels are visible. If you were using grouped elements in the past
120     with static elements to lable the fields, then you will need to remove the statics.
122   + All the choices / answers have been merged into a single section of the form.
123     This works better with the new 'shortforms' MDL-30637. Also the
124     "Add blanks for more ..." buttons are now inside that section. This probably
125     requries that you remove any headings from your per-answer fields, and change
126     some of the labels.
128   + Having merged all the elements into one form section, we then used CSS to
129     visually group the fields for one choice, answer, etc.
131   + When editing an existing question, we only show as many repeats are are
132     actually needed until the user clicks the "Add blanks for more ..." button.
133     Where you have your own repeat elements, you may need to change the
134     number of repeats calculation.
136   + As with all forms, setType() is now required for all text form elements.
138   + A good example of a question type being upgraded to take account of all these
139     changes is
140     https://github.com/moodleou/moodle-qtype_pmatch/commit/9d8e1beb9f780246416a0f3a7622f700b8fa90c8
143 === 2.3.5 / 2.4.2 / 2.5 ===
145 * The special value question_attempt::PARAM_CLEANHTML_FILES that could be used
146   in the get_expected_data method was renamed to question_attempt::PARAM_RAW_FILES
147   in order to fix a bug. We failed to think this throught, and so did not realised
148   that this might break some question types. If this affected your question type,
149   please accept our apologies. Details in MDL-37847.
152 === 2.3 ===
154 * Support for backwards-compatible string names dropped. MDL-30120. (See under 2.2 below.)
155 * If you are overriding export_to_xml and import_from_xml to provide Moodle XML format
156   import and export, then you will probably get PHP strict syntax notices in developer
157   debug mode until you change the method signature to include qformat_xml $format.
158   That is, you need to specify the argument type.
159 * qtype_xxx_pluginfile() is now given the 7th parameter (hopefully the last
160   one) that contains additional options for the file serving. The array should
161   be re-passed to question_pluginfile() as is.
164 === 2.2 ===
166 * The XML import/export base class has had some minor API changes. The
167   - write_combined_feedback method now requires that you pass the questionid and
168     contextid. (MDL-29058)
169   - calls to the import_hints and import_answer methods now should pass the question
170     text format as the last argument, to be used as a default if necessary. (MDL-29739)
171   If you do not upgrade your code, it will not break, but there will be PHP
172   warnings, and it the export will not work 100% correctly.
174 * The old
175     public function requires_qtypes()
176 method is no more. Instead use the ->dependencies facility in version.php. E.g.
177 $plugin->dependencies = array(
178     'qtype_numerical' => 2011102700,
179 );
181 * The plugin name and related strings used to be defined in language strings
182 called the same thing as the format, for example:
184 $string['addingdescription'] = 'Adding a Description';
185 $string['description'] = 'Description';
186 $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.
187 $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.
188 $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.';
189 $string['editingdescription'] = 'Editing a Description';
191 All these need to be changed to use the standard string name pluginname, as for
192 other plugin types, and similar for the other strings.
194 $string['pluginname'] = 'Description';
195 $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.
196 $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.
197 $string['pluginnameadding'] = 'Adding a Description';
198 $string['pluginnameediting'] = 'Editing a Description';
199 $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.';
201 The old strings will continue to work, but only until Moodle 2.3 is released.
203 * If you are using the facilities provided by overriding the extra_answer_fields
204   or questionid_column_name methods, then you must change these to be public
205   methods. (This is required so that backup and restore can be made to work
206   automatically. MDL-24408, MDL-25617, MDL-30562)
209 === 2.1 ===
211 * Lots of API changes due to the new question engine. See
212 http://docs.moodle.org/dev/Developing_a_Question_Type#Converting_a_Moodle_2.0_question_type
215 === 2.0 ===
217 * Lots of changes due to all the API changes in Moodle 2.0.
219 * This plugin type now supports cron in the standard way. If required, Create a
220   lib.php file containing
221 function qtype_mypluginname_cron() {};