MDL-30985 Fixed up event API phpdocs
[moodle.git] / mod / quiz / db / events.php
1 <?php
2 // This file is part of Moodle - http://moodle.org/
3 //
4 // Moodle is free software: you can redistribute it and/or modify
5 // it under the terms of the GNU General Public License as published by
6 // the Free Software Foundation, either version 3 of the License, or
7 // (at your option) any later version.
8 //
9 // Moodle is distributed in the hope that it will be useful,
10 // but WITHOUT ANY WARRANTY; without even the implied warranty of
11 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12 // GNU General Public License for more details.
13 //
14 // You should have received a copy of the GNU General Public License
15 // along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
17 /**
18  * Add event handlers for the quiz
19  *
20  * @package    mod_quiz
21  * @category   event
22  * @copyright  2011 The Open University
23  * @license    http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
24  */
27 defined('MOODLE_INTERNAL') || die();
30 $handlers = array(
31     // Handle our own quiz_attempt_submitted event, as a way to send confirmation
32     // messages asynchronously.
33     'quiz_attempt_submitted' => array (
34         'handlerfile'     => '/mod/quiz/locallib.php',
35         'handlerfunction' => 'quiz_attempt_submitted_handler',
36         'schedule'        => 'cron',
37     ),
38 );
40 /* List of events generated by the quiz module, with the fields on the event object.
42 quiz_attempt_started
43     ->component   = 'mod_quiz';
44     ->attemptid   = // The id of the new quiz attempt.
45     ->timestart   = // The timestamp of when the attempt was started.
46     ->userid      = // The user id that the attempt belongs to.
47     ->quizid      = // The quiz id of the quiz the attempt belongs to.
48     ->cmid        = // The course_module id of the quiz the attempt belongs to.
49     ->courseid    = // The course id of the course the quiz belongs to.
51 quiz_attempt_submitted
52     ->component   = 'mod_quiz';
53     ->attemptid   = // The id of the quiz attempt that was submitted.
54     ->timefinish  = // The timestamp of when the attempt was submitted.
55     ->userid      = // The user id that the attempt belongs to.
56     ->submitterid = // The user id of the user who sumitted the attempt.
57     ->quizid      = // The quiz id of the quiz the attempt belongs to.
58     ->cmid        = // The course_module id of the quiz the attempt belongs to.
59     ->courseid    = // The course id of the course the quiz belongs to.
61 */