MDL-35038 quiz reports: document the API changes in 2.3.
[moodle.git] / mod / quiz / report / upgrade.txt
1 This files describes API changes for quiz report plugins.
3 Overview of this plugin type at http://docs.moodle.org/dev/Quiz_reports
6 === earlier versions ===
8 * ... API changes were not documented properly. Sorry. (There weren't many!)
11 === 2.2 ===
13 * Plugins should be converted to implement cron in the standard way. In lib.php,
14 define a
15 function quiz_myreportname_cron() {};
16 This replaces the old way of having a separate cron.php file. Also, the cron
17 frequency should be defined in version.php, not in the quiz_reports table.
20 === 2.3 ===
22 * Support for the old way of doing cron in a separate cron.php file has been removed.
23 You need a lib.php file inside the pluginneme (quiz report name) and a cron function
24 with the name quiz_pluginname_cron(), where pluginnme is the report name (e.g.:
25 quiz_statistics_cron()).
27 * Some globally defined constants with the prefix "QUIZ_REPORT_ATTEMPTS_" are put inside
28 the abstract class "quiz_attempts_report" in Moodle 2.3.and they associate as follows:
30 withis the classes drived from "quiz_attempts_report":
32 parent::ALL_WITH            replaces    QUIZ_REPORT_ATTEMPTS_ALL
33 parent::ENROLLED_ALL        replaces    QUIZ_REPORT_ATTEMPTS_ALL_STUDENTS
34 parent::ENROLLED_WITH       replaces    QUIZ_REPORT_ATTEMPTS_STUDENTS_WITH
35 parent::ENROLLED_WITHOUT    replaces    QUIZ_REPORT_ATTEMPTS_STUDENTS_WITH_NO
37 anywhere else:
38 quiz_attempts_report::ALL_WITH            replaces    QUIZ_REPORT_ATTEMPTS_ALL
39 quiz_attempts_report::ENROLLED_ALL        replaces    QUIZ_REPORT_ATTEMPTS_ALL_STUDENTS
40 quiz_attempts_report::ENROLLED_WITH       replaces    QUIZ_REPORT_ATTEMPTS_STUDENTS_WITH
41 quiz_attempts_report::ENROLLED_WITHOUT    replaces    QUIZ_REPORT_ATTEMPTS_STUDENTS_WITH_NO
43 * The clas "quiz_attempt_report" ahd been renbamed as "quiz_attempts_report"