weekly release 2.6dev
[moodle.git] / lib / db / events.php
CommitLineData
117bd748 1<?php
5b4a78e2
PS
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/>.
ca4bcf58 16
5b4a78e2 17/**
ef6cf871 18 * Definition of core event handler and description of all events throws from core.
5b4a78e2 19 *
39b90b51
EL
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
1d1719f5 30 * @copyright 2007 onwards Martin Dougiamas http://dougiamas.com
39b90b51 31 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5b4a78e2 32 */
ca4bcf58 33
5b4a78e2 34defined('MOODLE_INTERNAL') || die();
2942a5cd 35
d8a1f426 36/* List of legacy event handlers */
2942a5cd 37
df997f84 38$handlers = array(
3b120e46 39
27806552
YB
40 'course_completed' => array (
41 'handlerfile' => '/lib/badgeslib.php',
42 'handlerfunction' => 'badges_award_handle_course_criteria_review',
43 'schedule' => 'instant',
44 'internal' => 1,
45 ),
46 'activity_completion_changed' => array (
47 'handlerfile' => '/lib/badgeslib.php',
48 'handlerfunction' => 'badges_award_handle_activity_criteria_review',
49 'schedule' => 'instant',
50 'internal' => 1,
51 ),
52 'user_updated' => array (
53 'handlerfile' => '/lib/badgeslib.php',
54 'handlerfunction' => 'badges_award_handle_profile_criteria_review',
55 'schedule' => 'instant',
56 'internal' => 1,
57 ),
fc053de9 58
d8a1f426
PS
59/*
60 * portfolio queued event - for non interactive file transfers
61 * NOTE: this is a HACK, please do not add any more things like this here
62 * (it is just abusing cron to do very time consuming things which is wrong any way)
63 *
64 * TODO: this has to be moved into separate queueing framework....
65 */
66 'portfolio_send' => array (
67 'handlerfile' => '/lib/portfolio.php',
68 'handlerfunction' => 'portfolio_handle_event', // argument to call_user_func(), could be an array
69 'schedule' => 'cron',
70 'internal' => 0,
71 ),
72
df997f84 73/* no more here please, core should not consume any events!!!!!!! */
3b120e46 74);
75
ca4bcf58 76
2942a5cd 77
78
79/* List of events thrown from Moodle core
80
81==== user related events ====
82
83user_created - object user table record
84user_updated - object user table record
85user_deleted - object user table record
a8e3b008 86user_logout - full $USER object
2942a5cd 87
88==== course related events ====
89
90course_category_updated - object course_categories table record
91course_category_created - object course_categories table record
92course_category_deleted - object course_categories table record
93
94course_created - object course table record
95course_updated - object course table record
582bae08
PS
96course_content_removed - object course table record + context property
97course_deleted - object course table record + context property
bf989c2f 98course_restored - custom object with courseid, userid and restore information
2942a5cd 99
df997f84 100user_enrolled - object record from user_enrolments table + courseid,enrol
358fb4dc 101user_enrol_modified - object record from user_enrolments table + courseid,enrol
df997f84
PS
102user_unenrolled - object record from user_enrolments table + courseid,enrol,lastenrol
103
104==== cohort related events ===
105
106
107cohort_added - object cohort table record
108cohort_updated - object cohort table record
109cohort_deleted - object cohort table record
110
111cohort_member_added - object cohortid, userid properties
112cohort_member_removed - object cohortid, userid properties
113
2942a5cd 114==== group related events ====
115
116groups_group_created - object groups_group table record
117groups_group_updated - object groups_group table record
118groups_group_deleted - object groups_group table record
119
120groups_member_added - object userid, groupid properties
121groups_member_removed - object userid, groupid properties
122
123groups_grouping_created - object groups_grouping table record
124groups_grouping_updated - object groups_grouping table record
125groups_grouping_deleted - object groups_grouping table record
126
ffc670d9 127groups_members_removed - object courseid+userid - removed all users (or one user) from all groups in course
2942a5cd 128groups_groupings_groups_removed - int course id - removed all groups from all groupings in course
129groups_groups_deleted - int course id - deleted all course groups
130groups_groupings_deleted - int course id - deleted all course groupings
131
906fb8f8 132==== role related events ====
96608a55 133
134role_assigned - object role_assignments table record
135role_unassigned - object role_assignments table record
136
9645a484 137==== activity module events ====
75ba5fe4 138
9645a484
MD
139mod_deleted - int courseid, int cmid, text modulename - happens when a module is deleted
140mod_created - int courseid, int cmid, text modulename - happens when a module is created
141mod_updated - int courseid, int cmid, text modulename - happens when a module is updated
75ba5fe4 142
af7e05d6
EL
143=== blog events
144
145blog_entry_added - blog post object
146blog_entry_edited - blog post object
147blog_entry_deleteded - blog post object
148
2942a5cd 149*/