weekly release 2.5dev
[moodle.git] / lib / 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  * Definition of core event handler and description of all events throws from core.
19  *
20  * The handlers defined on this file are processed and registered into
21  * the Moodle DB after any install or upgrade operation. All plugins
22  * support this.
23  *
24  * For more information, take a look to the documentation available:
25  *     - Events API: {@link http://docs.moodle.org/dev/Events_API}
26  *     - Upgrade API: {@link http://docs.moodle.org/dev/Upgrade_API}
27  *
28  * @package   core
29  * @category  event
30  * @copyright 2007 onwards Martin Dougiamas  http://dougiamas.com
31  * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
32  */
34 defined('MOODLE_INTERNAL') || die();
36 /* List of handlers */
38 $handlers = array(
40 /*
41  * portfolio queued event - for non interactive file transfers
42  * NOTE: this is a HACK, please do not add any more things like this here
43  *       (it is just abusing cron to do very time consuming things which is wrong any way)
44  *
45  * TODO: this has to be moved into separate queueing framework....
46  */
47     'portfolio_send' => array (
48         'handlerfile'      => '/lib/portfolio.php',
49         'handlerfunction'  => 'portfolio_handle_event',    // argument to call_user_func(), could be an array
50         'schedule'         => 'cron',
51         'internal'         => 0,
52     ),
55 /* no more here please, core should not consume any events!!!!!!! */
56 );
61 /* List of events thrown from Moodle core
63 ==== user related events ====
65 user_created - object user table record
66 user_updated - object user table record
67 user_deleted - object user table record
68 user_logout - full $USER object
70 ==== course related events ====
72 course_category_updated - object course_categories table record
73 course_category_created - object course_categories table record
74 course_category_deleted - object course_categories table record
76 course_created - object course table record
77 course_updated - object course table record
78 course_content_removed - object course table record + context property
79 course_deleted - object course table record + context property
80 course_restored - custom object with courseid, userid and restore information
82 user_enrolled - object record from user_enrolments table + courseid,enrol
83 user_enrol_modified - object record from user_enrolments table + courseid,enrol
84 user_unenrolled - object record from user_enrolments table + courseid,enrol,lastenrol
86 ==== cohort related events ===
89 cohort_added - object cohort table record
90 cohort_updated - object cohort table record
91 cohort_deleted - object cohort table record
93 cohort_member_added - object cohortid, userid properties
94 cohort_member_removed - object cohortid, userid properties
96 ==== group related events ====
98 groups_group_created - object groups_group table record
99 groups_group_updated - object groups_group table record
100 groups_group_deleted - object groups_group table record
102 groups_member_added   - object userid, groupid properties
103 groups_member_removed - object userid, groupid properties
105 groups_grouping_created - object groups_grouping table record
106 groups_grouping_updated - object groups_grouping table record
107 groups_grouping_deleted - object groups_grouping table record
109 groups_members_removed          - object courseid+userid - removed all users (or one user) from all groups in course
110 groups_groupings_groups_removed - int course id - removed all groups from all groupings in course
111 groups_groups_deleted           - int course id - deleted all course groups
112 groups_groupings_deleted        - int course id - deleted all course groupings
114 ==== role related events ====
116 role_assigned         - object role_assignments table record
117 role_unassigned       - object role_assignments table record
119 ==== activity module events ====
121 mod_deleted - int courseid, int cmid, text modulename - happens when a module is deleted
122 mod_created - int courseid, int cmid, text modulename - happens when a module is created
123 mod_updated - int courseid, int cmid, text modulename - happens when a module is updated
125 === blog events
127 blog_entry_added - blog post object
128 blog_entry_edited - blog post object
129 blog_entry_deleteded - blog post object
131 */