public/question/UPGRADING.md
During restore of a question_set_reference, mapping of IDs in the filtercondition is now delegated to qbank plugins. If your qbank plugin defines a filter condition that uses database IDs, add an override of restore_filtercondition() to the condition class, which checks the condition's data and replaces the IDs with mapped values if required. See qbank_managecategories\category_condition for an example.
For more information see MDL-86524
Moved the route for returning counts of questions in each of a course's question banks to /api/rest/v2/question/counts, for a more RESTful URL and consistency with other core_question routes.
For more information see MDL-87264
Added a new route at /api/rest/v2/question/categories for returning a list of question categories in a particular course module.
For more information see MDL-87264
The UI for switching question banks is now encapsulated in the core_question/bank_switcher Javascript module. This takes an existing modal and replaces the content with the switcher. It will then emit a custom bankSwitched event on the modal's DOM element when a new bank is selected.
For more information see MDL-87264
get_next_version() from questionlib.php is now deprecated. Use \core_question\versions::get_next_version() instead.
For more information see MDL-86798
The \core_question\output\switch_question_bank renderable is now deprecated, as rendering of the switch_question_bank template is now all handled client-side by the core_question/bank_switcher Javascript module.
For more information see MDL-87264
core_question\output\question_category_selector::question_count_sql has been replaces with core_question\local\bank\question_counts\by_category_query, to keep all the question counting logic together in one place.
For more information see MDL-87848
core_question:
- message: |
Final deprecation of moodle-question-chooser YUI module.
type: removed
- message: |
Final deprecation of core_question/qbank_chooser template.
type: removed
For more information see MDL-81961
public/question/renderer.php:
\core_question_bank_renderer::render_category_condition()\core_question_bank_renderer::render_category_condition_advanced()\core_question_bank_renderer::render_hidden_condition_advanced()For more information see MDL-87425
In order to prevent re-use of question version numbers after a version is deleted, the nextversion column was added to question_bank_entries. This serves as a counter incremented each time a version is created.
Do not query this field directly. Instead use core_question\versions::get_next_version() to read the value, which will initialise it based on the existing versions if it is not set yet. By default, it will increment the version number automatically, unless you pass increment: false. Because of this, it is advisable to call it inside a transaction, that is only committed after the version number is used in a question_versions record.
For more information see MDL-86798
The question backup API has been improved to only include questions that are actually used or owned by backed up activities.
Any activities that use question references should be supported automatically. Activities that use question set references (for example, random quiz questions) need to add a call to backup_question_set_reference_trait::annotate_set_reference_bank_entries() alongside the call to backup_question_set_reference_trait::add_question_set_references() in their backup step. See backup_quiz_activity_structure_step::define_structure() for an example.
For more information see MDL-41924
core_question_search_shared_banks will now search all question banks, not just those outside the current course.
This makes the service usable in cases outside of the current "Switch banks" UI, which require searching all banks on the site.
It also makes the autocomplete in the "Switch banks" UI more consistent, as it was previously excluding some of the banks listed in the UI (Question banks in this course), but not others (Recently viewed question banks).
This change has also adds a 'requiredcapabilties' parameter to the function, which accepts an list of abbreviated capabilities for checking access against question banks before they are returned.
For more information see MDL-85069
question_edit_contexts now only considers the provided context when checking permissions, rather than all parent contexts as well. As questions now exist only at the activity module context level, permissions can be inherited or overridden as normal for each question bank. The previous pattern of checking for a permission in any parent context circumvented the override system, and no longer makes sense.
For more information see MDL-85754
Intial deprecation of core_question_bank_renderer::render_question_pagination() and the associated template file. Rendering the question pagination is now done via ajax based pagination.
For more information see MDL-78091
Final deprecation of:
For more information see MDL-78091
The unit test repeated_restore_test::test_restore_course_with_same_stamp_questions was passing incorrectly on 5.x for question types that use answers. Maintainers of third-party question types may want to re-run the test with the fix in place, or if they have copied parts of this test as the basis of a test in their own plugin, review the changes and see if they should be reflected in their own test.
For more information see MDL-85556
The get_bulk_actions() method on the base plugin_features_base class has been changed to allow a qbank view object to be passed through. This is nullable and therefore optional for qbank plugins which don't need to do so.
For more information see MDL-79281
Question bank Condition classes can now implement a function called "filter_invalid_values($filterconditions)" to remove anything from the filterconditions array which is invalid or should not be there.
For more information see MDL-83784
question_attempt_step's constructor now accepts the class constant TIMECREATED_ON_FIRST_RENDER as a value for the $timecreated parameter. Calling question_attempt::render for the first time will now set the first step's timecreated to the current time if it is set to this value. Note, null could not be used here as it is already used to indicate timecreated should be set to the current time.
For more information see MDL-68806
The definition of the abstract core_question\local\bank\condition class has changed to make it clearer which methods are required in child classes.
The get_filter_class method is no longer declared as abstract, and will return null by default to use the base core/datafilter/filtertype class. If you have defined this method to return null in your own class, it will continue to work, but it is no longer necessary.
build_query_from_filter and get_condition_key are now declared as abstract, since all filter condition classes must define these (as well as existing abstract methods) to function. Again, exsiting child classes will continue to work if they did before, as they already needed these methods.
For more information see MDL-83859
question_type::generate_test
No replacement, not used anywhere in core.
For more information see MDL-71378
Deprecated method mod_quiz\question\bank\qbank_helper::get_version_options in favour of core_question\local\bank\version_options::get_version_options so that the method is in core rather than a module, and can safely be used from anywhere as required.
For more information see MDL-77713
Behat steps behat_qbank_comment::i_should_see_on_the_column and behat_qbank_comment::i_click_on_the_row_containing have been deprecated in favour of the new component named selectors, qbank_comment > Comment count link and qbank_comment > Comment count text which can be used with the standard should exist and I click on steps to replace the custom steps.
For more information see MDL-79122
Final deprecation of:
For more information see MDL-78090
Duplication or multiple restores of questions has been modified to avoid errors where a question with the same stamp already exists in the target category. To achieve this all data for the question is hashed, excluding any ID fields.
The question data from the backup is first reformatted to match the questiondata structure returned by calling get_question_options() (see https://docs.moodle.org/dev/Question_data_structures#Representation_1:_%24questiondata). Common question elements will be handled automatically, but any elements that the qtype adds to the backup will need to be handled by overriding restore_qtype_plugin::convert_backup_to_questiondata. See restore_qtype_match_plugin as an example.
If a qtype plugin calls any $this->add_question_*() methods in its restore_qtype_*_plugin::define_question_plugin_structure() method, the ID fields used in these records will be excluded automatically.
If a qtype plugin defines its own tables with ID fields, it must define restore_qtype_*_plugin::define_excluded_identity_hash_fields() to return an array of paths to these fields within the question data. This should be all that is required for the majority of plugins. See the PHPDoc of restore_qtype_plugin::define_excluded_identity_hash_fields() for a full explanation of how these paths should be defined, and restore_qtype_truefalse_plugin for an example.
If the data structure for a qtype returned by calling get_question_options() contains data other than ID fields that are not contained in the backup structure or vice-versa, it will need to override restore_qtype_*_plugin::remove_excluded_question_data() to remove the inconsistent data. See restore_qtype_multianswer_plugin as an example.
For more information see MDL-83541
A new utility function \question_utils::format_question_fragment() has been created so that question content can filter based on filters.
For more information see MDL-78662
\core_question\local\bank\column_base::from_column_name() method now accepts a bool $ingoremissing parameter, which can be used to ignore if the class does not exist, instead of throwing an exception.
For more information see MDL-81407