MDL-30981 Upgrade API: Added related phpdocs
[moodle.git] / lib / db / messages.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/>.
120b3758 16
5b4a78e2
PS
17/**
18 * Defines message providers (types of messages being sent)
19 *
39b90b51
EL
20 * The providers 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 * - Message API: {@link http://docs.moodle.org/dev/Message_API}
26 * - Upgrade API: {@link http://docs.moodle.org/dev/Upgrade_API}
27 *
28 * @package core
29 * @category message
30 * @copyright 2008 onwards Martin Dougiamas http://dougiamas.com
31 * @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
5b4a78e2
PS
32 */
33
34defined('MOODLE_INTERNAL') || die();
120b3758 35
36$messageproviders = array (
37
39b90b51 38 // Notices that an admin might be interested in
6f5e0852 39 'notices' => array (
120b3758 40 'capability' => 'moodle/site:config'
41 ),
42
39b90b51 43 // Important errors that an admin ought to know about
120b3758 44 'errors' => array (
45 'capability' => 'moodle/site:config'
17da2e6f 46 ),
120b3758 47
17da2e6f 48 'instantmessage' => array (
7a04c476
RK
49 'defaults' => array(
50 'popup' => MESSAGE_PERMITTED + MESSAGE_DEFAULT_LOGGEDIN + MESSAGE_DEFAULT_LOGGEDOFF,
51 'email' => MESSAGE_PERMITTED + MESSAGE_DEFAULT_LOGGEDOFF,
52 ),
17da2e6f 53 ),
6f5e0852 54
bac233d3
SH
55 'backup' => array (
56 'capability' => 'moodle/site:config'
a1708181 57 ),
58
39b90b51 59 // Course creation request notification
a1708181 60 'courserequested' => array (
61 'capability' => 'moodle/site:approvecourse'
62 ),
63
39b90b51 64 // Course request approval notification
a1708181 65 'courserequestapproved' => array (
66 'capability' => 'moodle/course:request'
67 ),
68
39b90b51 69 // Course request rejection notification
a1708181 70 'courserequestrejected' => array (
71 'capability' => 'moodle/course:request'
bac233d3
SH
72 )
73
120b3758 74);