weekly release 2.3dev (blame stronk7 for 0202 mistake)
[moodle.git] / message / output / lib.php
CommitLineData
1d422980 1<?php
3b120e46 2
3///////////////////////////////////////////////////////////////////////////
4// //
5// NOTICE OF COPYRIGHT //
6// //
7// Moodle - Modular Object-Oriented Dynamic Learning Environment //
8// http://moodle.com //
9// //
10// Copyright (C) 1999 onwards Martin Dougiamas http://moodle.com //
11// //
12// This program is free software; you can redistribute it and/or modify //
13// it under the terms of the GNU General Public License as published by //
14// the Free Software Foundation; either version 2 of the License, or //
15// (at your option) any later version. //
16// //
17// This program is distributed in the hope that it will be useful, //
18// but WITHOUT ANY WARRANTY; without even the implied warranty of //
19// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the //
20// GNU General Public License for more details: //
21// //
22// http://www.gnu.org/copyleft/gpl.html //
23// //
24///////////////////////////////////////////////////////////////////////////
25
26/**
27 * Base message output class
28 *
29 * @author Luis Rodrigues
3b120e46 30 * @license http://www.gnu.org/copyleft/gpl.html GNU Public License
1d422980 31 * @package
3b120e46 32 */
33
34/**
35 * Base message output class
36 */
1d422980 37abstract class message_output {
3b120e46 38 public abstract function send_message($message);
d18b1bbd 39 public abstract function process_form($form, &$preferences);
3b120e46 40 public abstract function load_data(&$preferences, $userid);
f3d095f8 41 public abstract function config_form($preferences);
cd8f78c8
RK
42 /**
43 * @return bool have all the necessary config settings been
44 * made that allow this plugin to be used.
45 */
46 public function is_system_configured() {
47 return true;
48 }
49 /**
50 * @param object $user the user object, defaults to $USER.
51 * @return bool has the user made all the necessary settings
52 * in their profile to allow this plugin to be used.
53 */
54 public function is_user_configured($user = null) {
55 return true;
56 }
57
7529f9e9
TH
58 /**
59 * @return int the Default message output settings for this output, for
60 * message providers that do not specify what the settings should be for
61 * this output in the messages.php file.
62 */
63 public function get_default_messaging_settings() {
64 return MESSAGE_PERMITTED;
65 }
3b120e46 66}
67
68
1d422980 69