| 1 |
efrain |
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 |
* SMS Gateway interface
|
|
|
19 |
*
|
|
|
20 |
* @package factor_sms
|
|
|
21 |
* @author Peter Burnett <peterburnett@catalyst-au.net>
|
|
|
22 |
* @copyright Catalyst IT
|
|
|
23 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
24 |
*/
|
|
|
25 |
|
|
|
26 |
namespace factor_sms\local\smsgateway;
|
|
|
27 |
|
|
|
28 |
interface gateway_interface {
|
|
|
29 |
|
|
|
30 |
/**
|
|
|
31 |
* Sends an SMS message
|
|
|
32 |
*
|
|
|
33 |
* @param string $messagecontent the content to send in the SMS message.
|
|
|
34 |
* @param string $phonenumber the destination for the message.
|
|
|
35 |
* @return bool true on message send success
|
|
|
36 |
*/
|
|
|
37 |
public function send_sms_message(string $messagecontent, string $phonenumber): bool;
|
|
|
38 |
|
|
|
39 |
/**
|
|
|
40 |
* Add gateway specific settings to the SMS factor settings page.
|
|
|
41 |
*
|
|
|
42 |
* @param \admin_settingpage $settings
|
|
|
43 |
* @return void
|
|
|
44 |
*/
|
|
|
45 |
public static function add_settings(\admin_settingpage $settings): void;
|
|
|
46 |
|
|
|
47 |
/**
|
|
|
48 |
* Returns whether or not the gateway is enabled
|
|
|
49 |
*
|
|
|
50 |
* @return bool
|
|
|
51 |
*/
|
|
|
52 |
public static function is_gateway_enabled(): bool;
|
|
|
53 |
}
|