MDL-30981 Upgrade API: Added related phpdocs
[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
36/* List of handlers */
37
df997f84 38$handlers = array(
3b120e46 39
fc053de9 40/*
41 * portfolio queued event - for non interactive file transfers
df997f84
PS
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 */
fc053de9 47 'portfolio_send' => array (
48 'handlerfile' => '/lib/portfolio.php',
49 'handlerfunction' => 'portfolio_handle_event', // argument to call_user_func(), could be an array
650462df
PS
50 'schedule' => 'cron',
51 'internal' => 0,
fc053de9 52 ),
3b120e46 53
fc053de9 54
df997f84 55/* no more here please, core should not consume any events!!!!!!! */
3b120e46 56);
57
ca4bcf58 58
2942a5cd 59
60
61/* List of events thrown from Moodle core
62
63==== user related events ====
64
65user_created - object user table record
66user_updated - object user table record
67user_deleted - object user table record
a8e3b008 68user_logout - full $USER object
2942a5cd 69
70==== course related events ====
71
72course_category_updated - object course_categories table record
73course_category_created - object course_categories table record
74course_category_deleted - object course_categories table record
75
76course_created - object course table record
77course_updated - object course table record
582bae08
PS
78course_content_removed - object course table record + context property
79course_deleted - object course table record + context property
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
2942a5cd 124*/