Merge branch 'MDL-47132' of git://
[moodle.git] / mod / quiz / upgrade.txt
1 This files describes API changes in the quiz code.
3 === 2.8 ===
5 * Classes that were defined in various lib files have been moved to the classes
6   folder to take advantage of auto-loading. This has involved renaming them.
7   see the list in mod/quiz/db/renamedclasses.php.
10 * Major changes to the Edit quiz page.
12   The goal of this work was to increase usability, and also clean up the page
13   enough that it will be possible to add new features in future.
15   Display of mod/quiz/edit.php is now entirely generated by
16   mod_quiz\output\edit_renderer. This uses a helper class mod_quiz\structure
17   to provide details of the structure of the quiz, and mod_quiz\repaginate to
18   alter that structure. (Actually, there are still some modification methods on
19   mod_quiz\structure. Expect that to be cleaned up in future.)
21   The new code uses much more ajax, and there are new scripts mod/quiz/edit_rest.php
22   and mod/quiz/repaginate.php to handle this. (Again, don't be surprised if those
23   two scripts get merged in future.) Also questionbank.ajax.php (which may, in
24   future, be made more generic, and moved into the core question bank code.)
26   As a result of this, mod/quiz/editlib.php has gone. (A few remaining functions
27   were moved to locallib.php.)
29   Here is a list of all the old functions or classes that have changed.
30   If you used any of these in custom code, you will need to update your code.
31   (Note that many of these functions should have been considered private internals
32   of the quiz module, and you should not have been using them!)
34   From editlib.php:
35       quiz_remove_slot
36       quiz_delete_empty_page
37       quiz_add_page_break_after_slot    - Use methods of structure or repaginate
38       quiz_update_slot_maxmark          - classes instead.
39       _quiz_move_question
40       quiz_move_question_up
41       quiz_move_question_down
43       quiz_print_question_list
44       quiz_print_pagecontrols
45       quiz_print_singlequestion         - Use methods of edit_renderer instead.
46       quiz_print_randomquestion
47       quiz_print_singlequestion_reordertool
48       quiz_print_randomquestion_reordertool
49       print_random_option_icon
50       quiz_print_grading_form
51       quiz_print_status_bar
53   Moved from editlib.php to locallib.php:
54       quiz_question_tostring - now always returns a string (the only option used).
55                                The $return argument has gone.
57   Old editing JavaScript (e.g. mod/quiz/edit.js) is gone. Replaced with YUI modules.
60 === 2.7.1 ===
62 * The function quiz_fire_attempt_started_event has been removed. This function
63   should not have been used outside the quiz, but if you were using it, you should
64   trigger the event outside this function. Note that the appropriate start event is
65   fired automatically by the quiz_attempt_save_started function.
67 === 2.7 ===
69 * The old quiz.questions database column (comma-separated list of question ids)
70   is gone, and instead the quiz_question_instances table has been renamed to
71   to quiz_slots. Some of the columns of that table have been renamed to match
72   the coding guidelines. Specifically:
73       quiz     -> quizid
74       question -> questionid
75       grade    -> maxmark
76   also there are two new columns:
77       slot     -  numbers the questions in the quiz in order, as on the edit quiz page.
78       page     -  new way to determine which question is on which page.
79   naturally, other parts of the code and APIs have been updated to reflect that
80   change.
82 * The following functions, which were part of the internal workings of the quiz,
83   have been removed.
84       quiz_get_slot_for_question
85       quiz_number_of_questions_in_quiz
86       quiz_repaginate               (there is now a quiz_repaginate_questions with a different API).
87       quiz_add_page_break_at        (see quiz_add_page_break_after_slot)
88       quiz_add_page_break_after     (see quiz_add_page_break_after_slot)
89       quiz_number_of_pages
90       quiz_remove_question          (see quiz_remove_slot)
91       quiz_update_question_instance (see quiz_update_slot_maxmark)
93 * The following internal functions have had their API changed.
94       quiz_delete_empty_page: has had its arguments changed to $quiz and $pagenumber.
95       quiz_has_question_use: now takes $quiz and $slot, not $questionid.
97 === 2.6 ===
99 * As part of improving the page usability and accessibility, we updated the
100   heading levels for quiz module so it has a proper nesting. (MDL-41615)
102 * mod_quiz_renderer::view_best_score has been removed. (It did not do what the
103   name suggested anyway.)
106 === 2.4 ===
108 * mod_quiz_renderer::finish_review_link now requires $attemptobj to be passed in
109   instead of a moodle_url.
112 === Earlier changes ===
114 * Were not documented in this way. Sorry.