MDL-10107 Fixed the definition of message providers ... it now works through files...
[moodle.git] / lib / db / events.php
1 <?php // $Id$
3 ///////////////////////////////////////////////////////////////////////////
4 // Defines core event handlers                                           //
5 ///////////////////////////////////////////////////////////////////////////
6 //                                                                       //
7 // NOTICE OF COPYRIGHT                                                   //
8 //                                                                       //
9 // Moodle - Modular Object-Oriented Dynamic Learning Environment         //
10 //          http://moodle.org                                            //
11 //                                                                       //
12 // Copyright (C) 1999 onwards  Martin Dougiamas  http://moodle.com       //
13 //                                                                       //
14 // This program is free software; you can redistribute it and/or modify  //
15 // it under the terms of the GNU General Public License as published by  //
16 // the Free Software Foundation; either version 2 of the License, or     //
17 // (at your option) any later version.                                   //
18 //                                                                       //
19 // This program is distributed in the hope that it will be useful,       //
20 // but WITHOUT ANY WARRANTY; without even the implied warranty of        //
21 // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the         //
22 // GNU General Public License for more details:                          //
23 //                                                                       //
24 //          http://www.gnu.org/copyleft/gpl.html                         //
25 //                                                                       //
26 ///////////////////////////////////////////////////////////////////////////
30 /* List of handlers */
32 $handlers = array (
34 /* Messaging required parameters (object):
35  *  modulename     - 
36  *  userfrom
37  *  userto
38  *  subject
39  *  fullmessage - the full message in a given format
40  *  fullmessageformat  - the format if the full message (FORMAT_MOODLE, FORMAT_HTML, ..)
41  *  fullmessagehtml  - the full version (the message processor will choose with one to use) 
42  *  smallmessage - the small version of the message
43  */
45     'message_send' => array (
46          'handlerfile'      => '/lib/messagelib.php',
47          'handlerfunction'  => 'message_send_handler', 
48          'schedule'         => 'instant'
49      ),
51 /*
52  * portfolio queued event - for non interactive file transfers
53 */
54     'portfolio_send' => array (
55         'handlerfile'      => '/lib/portfolio.php',
56         'handlerfunction'  => 'portfolio_handle_event',    // argument to call_user_func(), could be an array
57         'schedule'         => 'cron'
58     ),
61 /* more go here */
62 );
67 /* List of events thrown from Moodle core
69 ==== user related events ====
71 user_created - object user table record
72 user_updated - object user table record
73 user_deleted - object user table record
75 ==== course related events ====
77 course_category_updated - object course_categories table record
78 course_category_created - object course_categories table record
79 course_category_deleted - object course_categories table record
81 course_created - object course table record
82 course_updated - object course table record
83 course_deleted - object course table record
85 ==== group related events ====
87 groups_group_created - object groups_group table record
88 groups_group_updated - object groups_group table record
89 groups_group_deleted - object groups_group table record
91 groups_member_added   - object userid, groupid properties
92 groups_member_removed - object userid, groupid properties
94 groups_grouping_created - object groups_grouping table record
95 groups_grouping_updated - object groups_grouping table record
96 groups_grouping_deleted - object groups_grouping table record
98 groups_members_removed          - object courseid+userid - removed all users (or one user) from all groups in course
99 groups_groupings_groups_removed - int course id - removed all groups from all groupings in course
100 groups_groups_deleted           - int course id - deleted all course groups
101 groups_groupings_deleted        - int course id - deleted all course groupings
103 ==== role related evetns ====
105 role_assigned         - object role_assignments table record
106 role_unassigned       - object role_assignments table record
108 */
110 ?>