Code Coverage |
||||||||||
Lines |
Functions and Methods |
Classes and Traits |
||||||||
| Total | |
40.00% |
6 / 15 |
|
25.00% |
1 / 4 |
CRAP | |
0.00% |
0 / 1 |
| MessagingService | |
40.00% |
6 / 15 |
|
25.00% |
1 / 4 |
21.82 | |
0.00% |
0 / 1 |
| getTransport | |
28.57% |
2 / 7 |
|
0.00% |
0 / 1 |
9.83 | |||
| setTransport | |
0.00% |
0 / 3 |
|
0.00% |
0 / 1 |
2 | |||
| send | |
75.00% |
3 / 4 |
|
0.00% |
0 / 1 |
2.06 | |||
| isAvailable | |
100.00% |
1 / 1 |
|
100.00% |
1 / 1 |
1 | |||
| 1 | <?php |
| 2 | |
| 3 | /** |
| 4 | * |
| 5 | * This program is free software; you can redistribute it and/or |
| 6 | * modify it under the terms of the GNU General Public License |
| 7 | * as published by the Free Software Foundation; under version 2 |
| 8 | * of the License (non-upgradable). |
| 9 | * |
| 10 | * This program is distributed in the hope that it will be useful, |
| 11 | * but WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 | * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 13 | * GNU General Public License for more details. |
| 14 | * |
| 15 | * You should have received a copy of the GNU General Public License |
| 16 | * along with this program; if not, write to the Free Software |
| 17 | * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. |
| 18 | * |
| 19 | * Copyright (c) 2013 (original work) Open Assessment Technologies SA (under the project TAO-PRODUCT); |
| 20 | * |
| 21 | */ |
| 22 | |
| 23 | namespace oat\tao\model\messaging; |
| 24 | |
| 25 | use oat\tao\model\messaging\transportStrategy\MailAdapter; |
| 26 | |
| 27 | /** |
| 28 | * Service to send messages to Tao Users |
| 29 | * |
| 30 | * @author bout |
| 31 | */ |
| 32 | class MessagingService extends \tao_models_classes_Service |
| 33 | { |
| 34 | public const CONFIG_KEY = 'messaging'; |
| 35 | |
| 36 | /** |
| 37 | * @var Transport |
| 38 | */ |
| 39 | private $transport = null; |
| 40 | |
| 41 | /** |
| 42 | * Get the current transport implementation |
| 43 | * |
| 44 | * @return Transport |
| 45 | */ |
| 46 | protected function getTransport() |
| 47 | { |
| 48 | if (is_null($this->transport)) { |
| 49 | $tao = \common_ext_ExtensionsManager::singleton()->getExtensionById('tao'); |
| 50 | $transport = $tao->getConfig(self::CONFIG_KEY); |
| 51 | if (!is_object($transport) || !$transport instanceof Transport) { |
| 52 | return false; |
| 53 | } |
| 54 | $this->transport = $transport; |
| 55 | } |
| 56 | return $this->transport; |
| 57 | } |
| 58 | |
| 59 | /** |
| 60 | * Set the transport implementation to use |
| 61 | * |
| 62 | * @param Transport $transporter |
| 63 | */ |
| 64 | public function setTransport(Transport $transporter) |
| 65 | { |
| 66 | $this->transport = $transporter; |
| 67 | $tao = \common_ext_ExtensionsManager::singleton()->getExtensionById('tao'); |
| 68 | $tao->setConfig(self::CONFIG_KEY, $this->transport); |
| 69 | } |
| 70 | |
| 71 | /** |
| 72 | * Send a message (destination is part of the message) |
| 73 | * |
| 74 | * @param Message $message |
| 75 | * @return boolean |
| 76 | */ |
| 77 | public function send(Message $message) |
| 78 | { |
| 79 | $transport = $this->getTransport(); |
| 80 | if ($transport == false) { |
| 81 | throw new \common_exception_InconsistentData('Transport strategy not correctly set for ' . __CLASS__); |
| 82 | } |
| 83 | return $this->getTransport()->send($message); |
| 84 | } |
| 85 | |
| 86 | /** |
| 87 | * Test if messaging is available |
| 88 | * |
| 89 | * @return boolean |
| 90 | */ |
| 91 | public function isAvailable() |
| 92 | { |
| 93 | return $this->getTransport() !== false; |
| 94 | } |
| 95 | } |