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/>.
  16
  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  */
  33
  34 defined('MOODLE_INTERNAL') || die();
  35
  36 /* List of legacy event handlers */
  37
  38 $handlers = array(
  39 /*
  40  * portfolio queued event - for non interactive file transfers
  41  * NOTE: this is a HACK, please do not add any more things like this here
  42  *       (it is just abusing cron to do very time consuming things which is wrong any way)
  43  *
  44  * TODO: this has to be moved into separate queueing framework....
  45  * TODO: MDL-25508, MDL-41541
  46  */
  47     'portfolio_send' => array (
  48         'handlerfile'      => '/lib/portfoliolib.php',
  49         'handlerfunction'  => 'portfolio_handle_event',    // argument to call_user_func(), could be an array
  50         'schedule'         => 'cron',
  51         'internal'         => 0,
  52     ),
  53
  54 /* no more here please, core should not consume any events!!!!!!! */
  55 );
  56
  57 $observers = array(
  58
  59     array(
  60         'eventname'   => '\core\event\course_module_completion_updated',
  61         'callback'    => 'core_badges_observer::course_module_criteria_review',
  62     ),
  63     array(
  64         'eventname'   => '\core\event\course_completed',
  65         'callback'    => 'core_badges_observer::course_criteria_review',
  66     ),
  67     array(
  68         'eventname'   => '\core\event\user_updated',
  69         'callback'    => 'core_badges_observer::profile_criteria_review',
  70     )
  71
  72 );
  73
  74
  75 /* List of events thrown from Moodle core
  76
  77 ==== user related events ====
  78
  79 user_created - object user table record
  80 user_updated - object user table record
  81 user_deleted - object user table record
  82 user_logout - full $USER object
  83
  84 ==== course related events ====
  85
  86 course_category_updated - object course_categories table record
  87 course_category_created - object course_categories table record
  88 course_category_deleted - object course_categories table record
  89
  90 course_created - object course table record
  91 course_updated - object course table record
  92 course_content_removed - object course table record + context property
  93 course_deleted - object course table record + context property
  94 course_restored - custom object with courseid, userid and restore information
  95
  96 user_enrolled - object record from user_enrolments table + courseid,enrol
  97 user_enrol_modified - object record from user_enrolments table + courseid,enrol
  98 user_unenrolled - object record from user_enrolments table + courseid,enrol,lastenrol
  99
 100 ==== cohort related events ===
 101
 102
 103 cohort_added - object cohort table record
 104 cohort_updated - object cohort table record
 105 cohort_deleted - object cohort table record
 106
 107 cohort_member_added - object cohortid, userid properties
 108 cohort_member_removed - object cohortid, userid properties
 109
 110 ==== group related events ====
 111
 112 groups_group_created - object groups_group table record
 113 groups_group_updated - object groups_group table record
 114 groups_group_deleted - object groups_group table record
 115
 116 groups_member_added   - object userid, groupid properties
 117 groups_member_removed - object userid, groupid properties
 118
 119 groups_grouping_created - object groups_grouping table record
 120 groups_grouping_updated - object groups_grouping table record
 121 groups_grouping_deleted - object groups_grouping table record
 122
 123 groups_members_removed          - object courseid+userid - removed all users (or one user) from all groups in course
 124 groups_groupings_groups_removed - int course id - removed all groups from all groupings in course
 125 groups_groups_deleted           - int course id - deleted all course groups
 126 groups_groupings_deleted        - int course id - deleted all course groupings
 127
 128 ==== role related events ====
 129
 130 role_assigned         - object role_assignments table record
 131 role_unassigned       - object role_assignments table record
 132
 133 ==== activity module events ====
 134
 135 mod_deleted - int courseid, int cmid, text modulename - happens when a module is deleted
 136 mod_created - int courseid, int cmid, text modulename - happens when a module is created
 137 mod_updated - int courseid, int cmid, text modulename - happens when a module is updated
 138
 139 === blog events
 140
 141 blog_entry_added - blog post object
 142 blog_entry_edited - blog post object
 143 blog_entry_deleteded - blog post object
 144
 145 */