MDL-34544 - assign - document assessable_ events
[moodle.git] / mod / assign / 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  * List of events generated by the assignment module
19  *
20  * @package   mod_assign
21  * @copyright 2012 NetSpot {@link http://www.netspot.com.au}
22  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
23  */
25 $handlers = array();
27 /* List of events generated by the assign module, with the fields on the event object.
29 assessable_content_uploaded
30     ->modulename     = 'assign';
31     ->cmid           = // The cmid of the assign.
32     ->itemid         = // The submission id of the user submission.
33     ->courseid       = // The course id of the course the assign belongs to.
34     ->userid         = // The user id that the attempt belongs to.
35     ->content        = // The text content entered by the user (empty if no content submitted)
36     ->pathnamehashes = // An array of pathnamehashes of the files submitted by the user (var not passed if not set).
38 assessable_file_uploaded
39     ->modulename     = 'assign';
40     ->cmid           = // The cmid of the assign.
41     ->itemid         = // The submission id of the user submission.
42     ->courseid       = // The course id of the course the assign belongs to.
43     ->userid         = // The user id that the attempt belongs to.
44     ->pathnamehashes = // An array of pathnamehashes of the files submitted by the user (var not passed if not set).
46 assessable_content_done
47     ->modulename     = 'assign';
48     ->cmid           = // The cmid of the assign.
49     ->itemid         = // The submission id of the user submission.
50     ->courseid       = // The course id of the course the assign belongs to.
51     ->userid         = // The user id that the attempt belongs to.
52 */