MDL-30981 Upgrade API: Added related phpdocs
[moodle.git] / lib / db / messages.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/>.
17 /**
18  * Defines message providers (types of messages being sent)
19  *
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
32  */
34 defined('MOODLE_INTERNAL') || die();
36 $messageproviders = array (
38     // Notices that an admin might be interested in
39     'notices' => array (
40          'capability'  => 'moodle/site:config'
41     ),
43     // Important errors that an admin ought to know about
44     'errors' => array (
45          'capability'  => 'moodle/site:config'
46     ),
48     'instantmessage' => array (
49         'defaults' => array(
50             'popup' => MESSAGE_PERMITTED + MESSAGE_DEFAULT_LOGGEDIN + MESSAGE_DEFAULT_LOGGEDOFF,
51             'email' => MESSAGE_PERMITTED + MESSAGE_DEFAULT_LOGGEDOFF,
52         ),
53     ),
55     'backup' => array (
56         'capability'  => 'moodle/site:config'
57     ),
59     // Course creation request notification
60     'courserequested' => array (
61         'capability'  => 'moodle/site:approvecourse'
62     ),
64     // Course request approval notification
65     'courserequestapproved' => array (
66          'capability'  => 'moodle/course:request'
67     ),
69     // Course request rejection notification
70     'courserequestrejected' => array (
71         'capability'  => 'moodle/course:request'
72     )
74 );