Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
n/a
0 / 0
n/a
0 / 0
CRAP
n/a
0 / 0
1<?php
2
3/**
4 * Interface for SMS classes.
5 *
6 * PHP version 8
7 *
8 * Copyright (C) Villanova University 2009.
9 *
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2,
12 * as published by the Free Software Foundation.
13 *
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17 * GNU General Public License for more details.
18 *
19 * You should have received a copy of the GNU General Public License
20 * along with this program; if not, write to the Free Software
21 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
22 *
23 * @category VuFind
24 * @package  SMS
25 * @author   Ronan McHugh <vufind-tech@lists.sourceforge.net>
26 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
27 * @link     https://vufind.org/wiki/development Wiki
28 */
29
30namespace VuFind\SMS;
31
32/**
33 * Interface for SMS classes.
34 *
35 * @category VuFind
36 * @package  SMS
37 * @author   Ronan McHugh <vufind-tech@lists.sourceforge.net>
38 * @license  http://opensource.org/licenses/gpl-2.0.php GNU General Public License
39 * @link     https://vufind.org/wiki/development Wiki
40 */
41interface SMSInterface
42{
43    /**
44     * Get validation type for phone numbers
45     *
46     * @return string
47     */
48    public function getValidationType();
49
50    /**
51     * Get a list of carriers supported by the module. Returned as an array of
52     * associative arrays indexed by carrier ID and containing "name" and "domain"
53     * keys.
54     *
55     * @return array
56     */
57    public function getCarriers();
58
59    /**
60     * Send a text message to the specified provider.
61     *
62     * @param string $provider The provider ID to send to
63     * @param string $to       The phone number at the provider
64     * @param string $from     The email address to use as sender
65     * @param string $message  The message to send
66     *
67     * @throws \VuFind\Exception\Mail
68     * @return void
69     */
70    public function text($provider, $to, $from, $message);
71}