on-demand release 2.7beta+
[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(
fd0e0192 39 /* No more old events! */
3b120e46 40);
41
137d94f3 42$observers = array(
ca4bcf58 43
137d94f3
RT
44 array(
45 'eventname' => '\core\event\course_module_completion_updated',
46 'callback' => 'core_badges_observer::course_module_criteria_review',
06f8ea7b
RT
47 ),
48 array(
49 'eventname' => '\core\event\course_completed',
50 'callback' => 'core_badges_observer::course_criteria_review',
bb78e249
RT
51 ),
52 array(
53 'eventname' => '\core\event\user_updated',
54 'callback' => 'core_badges_observer::profile_criteria_review',
137d94f3 55 )
06f8ea7b 56
137d94f3 57);
2942a5cd 58
59
60/* List of events thrown from Moodle core
61
62==== user related events ====
63
64user_created - object user table record
65user_updated - object user table record
66user_deleted - object user table record
a8e3b008 67user_logout - full $USER object
2942a5cd 68
69==== course related events ====
70
71course_category_updated - object course_categories table record
72course_category_created - object course_categories table record
73course_category_deleted - object course_categories table record
74
75course_created - object course table record
76course_updated - object course table record
582bae08
PS
77course_content_removed - object course table record + context property
78course_deleted - object course table record + context property
bf989c2f 79course_restored - custom object with courseid, userid and restore information
2942a5cd 80
df997f84 81user_enrolled - object record from user_enrolments table + courseid,enrol
358fb4dc 82user_enrol_modified - object record from user_enrolments table + courseid,enrol
df997f84
PS
83user_unenrolled - object record from user_enrolments table + courseid,enrol,lastenrol
84
85==== cohort related events ===
86
87
88cohort_added - object cohort table record
89cohort_updated - object cohort table record
90cohort_deleted - object cohort table record
91
92cohort_member_added - object cohortid, userid properties
93cohort_member_removed - object cohortid, userid properties
94
2942a5cd 95==== group related events ====
96
97groups_group_created - object groups_group table record
98groups_group_updated - object groups_group table record
99groups_group_deleted - object groups_group table record
100
101groups_member_added - object userid, groupid properties
102groups_member_removed - object userid, groupid properties
103
104groups_grouping_created - object groups_grouping table record
105groups_grouping_updated - object groups_grouping table record
106groups_grouping_deleted - object groups_grouping table record
107
ffc670d9 108groups_members_removed - object courseid+userid - removed all users (or one user) from all groups in course
2942a5cd 109groups_groupings_groups_removed - int course id - removed all groups from all groupings in course
110groups_groups_deleted - int course id - deleted all course groups
111groups_groupings_deleted - int course id - deleted all course groupings
112
906fb8f8 113==== role related events ====
96608a55 114
115role_assigned - object role_assignments table record
116role_unassigned - object role_assignments table record
117
9645a484 118==== activity module events ====
75ba5fe4 119
9645a484
MD
120mod_deleted - int courseid, int cmid, text modulename - happens when a module is deleted
121mod_created - int courseid, int cmid, text modulename - happens when a module is created
122mod_updated - int courseid, int cmid, text modulename - happens when a module is updated
75ba5fe4 123
af7e05d6
EL
124=== blog events
125
126blog_entry_added - blog post object
127blog_entry_edited - blog post object
128blog_entry_deleteded - blog post object
129
2942a5cd 130*/