MDL-48259 questionlib.php: remove functions deprecated in Moodle 2.1
[moodle.git] / question / upgrade.txt
CommitLineData
181393aa
TH
1This files describes API changes for code that uses the question API.
2
4c3c1b51
TH
3=== 2.9 ===
4
51) Some functions in questionlib.php where were deprecated in the past have now
6 beed deleted:
7
8 Deprecated since 2.1
9 * question_list_instances
10 * get_grade_options
11 * question_category_isused
12 * save_question_options
13 * question_get_real_state
14
15
16e246ac
TH
16=== 2.8 ===
17
181) This is jsut a warning that some methods of the question_engine_data_mapper
19 class have changed. All these methods are ones that you should not have been
20 calling directly from your code, so this should not cause any problems.
21 The changed methods are:
22 * insert_question_attempt
23 * insert_step_data
24 * update_question_attempt_step
25
26
efa5155a
RM
27=== 2.7 ===
28
291) Changes to class question_bank_view:
30
31 Filters, including $recurse and $showhidden, are now implemented as
d62382d1 32 pluggable \core_question\bank\search\condition classes.
efa5155a
RM
33
34 Therefore $recurse and $showhidden are no longer passed to the following functions:
35 protected function display_options [deprecated, use display_options_form()]
36 protected function build_query_sql [deprecated, use build_query()]
37
d62382d1 38 protected function display_category_form() is deprecated. Use \core_question\bank\search\category_condition
efa5155a 39
d62382d1 40 protected function display_category_form_checkbox deprecated use html_writer::checkbox and separate JavaScript
efa5155a
RM
41
42To add filters, local plugins can now implement the function local_[pluginname]_get_question_bank_search_conditions,
43
17f229fa
RM
442) To make columns available to question_bank_view, plugins can extend core_question\bank\column_base.
45 Users may choose to display additional columns by setting $CFG->questionbankcolumns to a comma-delimited list of columns.
46
473) The subsort separator has changed from _ to - in order to distinuguish subsorts vs frankenstyle component separators.
48
494) Because of the move to autoloading, $knowncolumntypes and known_field_types() are no longer used.
50
515) question_bank_column_base and it's derived classes have been namespaced to core_question\bank\column_base.
d62382d1 52
16e246ac 53
181393aa
TH
54=== 2.6 ===
55
b07ef13b
DP
561) Modules using the question bank MUST now declare their use of it with the xxx_supports()
57 flag FEATURE_USES_QUESTIONS. question_module_uses_questions() should be used to determine
58 if a module uses questions.
59
602) It is sometimes necessary to display bits of question content without having
181393aa
TH
61 and attempt (question_usage) in progress. Two examples of this are the option
62 in the question bank to display the questiontext, and in the quiz statistics
63 report, where it displays the question text above the report.
64
65 Previously, this display was done using a special method that only worked for
66 the question text, but which would not work for other parts of the question.
67 That old mechanism has been deprecated, and there is a new method that you
68 should use.
69
70 To display the question, replace calls to question_rewrite_questiontext_preview_urls
71 with calls to question_rewrite_question_preview_urls. Because the new function
72 is more flexibile, you have to pass more arguments.
73
74 To perform the necessary permission checks when the file is downloaded, you need
75 to implement the callback [component name]_question_preview_pluginfile.
76 (Previously you implemented [component name]_questiontext_preview_pluginfile.)
77 quiz_statistics_question_preview_pluginfile is an example of what to do.
78
79 question_send_questiontext_file has been deprecated. It is no longer necessary.
80
81 To ensure you are no longer using or defining any deprecated functions,
82 search for the regular expression:
83 question_rewrite_questiontext_preview_urls|_questiontext_preview_pluginfile|question_send_questiontext_file
70f22d60 84
c2f35e0b
TH
853) The argument list for core_question_renderer::mark_summary has changed.
86 Please update your calls. (The most likely scenario for this is if you have
87 overridden core_question_renderer::info in your own renderer.) You need to
88 make a change like:
89 - $this->mark_summary($qa, $options);
90 + $this->mark_summary($qa, $behaviouroutput, $options);