Code Coverage
 
Lines
Functions and Methods
Classes and Traits
Total
75.00% covered (warning)
75.00%
3 / 4
66.67% covered (warning)
66.67%
2 / 3
CRAP
0.00% covered (danger)
0.00%
0 / 1
AbstractBase
75.00% covered (warning)
75.00%
3 / 4
66.67% covered (warning)
66.67%
2 / 3
3.14
0.00% covered (danger)
0.00%
0 / 1
 __construct
100.00% covered (success)
100.00%
1 / 1
100.00% covered (success)
100.00%
1 / 1
1
 filterPhoneNumber
100.00% covered (success)
100.00%
2 / 2
100.00% covered (success)
100.00%
1 / 1
1
 getValidationType
0.00% covered (danger)
0.00%
0 / 1
0.00% covered (danger)
0.00%
0 / 1
2
1<?php
2
3/**
4 * Base class to enable sharing of common methods between SMS subclasses
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 * Base class to enable sharing of common methods between SMS subclasses
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 */
41abstract class AbstractBase implements SMSInterface
42{
43    /**
44     * SMS configuration
45     *
46     * @var \Laminas\Config\Config
47     */
48    protected $smsConfig;
49
50    /**
51     * Constructor
52     *
53     * @param \Laminas\Config\Config $config SMS configuration
54     */
55    public function __construct(\Laminas\Config\Config $config)
56    {
57        $this->smsConfig = $config;
58    }
59
60    /**
61     * Filter bad characters from a phone number
62     *
63     * @param string $num Phone number to filter
64     *
65     * @return string
66     */
67    protected function filterPhoneNumber($num)
68    {
69        $filter = $this->smsConfig->General->filter ?? '-.() ';
70        return str_replace(str_split($filter), '', $num);
71    }
72
73    /**
74     * Get validation type for phone numbers
75     *
76     * @return string
77     */
78    public function getValidationType()
79    {
80        // Load setting from config; at present, only US is implemented in templates
81        return $this->smsConfig->General->validation ?? 'US';
82    }
83}