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 | * This file is part of the phpBB Forum Software package. |
| 5 | * |
| 6 | * @copyright (c) phpBB Limited <https://www.phpbb.com> |
| 7 | * @license GNU General Public License, version 2 (GPL-2.0) |
| 8 | * |
| 9 | * For full copyright and license information, please see |
| 10 | * the docs/CREDITS.txt file. |
| 11 | * |
| 12 | */ |
| 13 | |
| 14 | namespace phpbb\messenger\method; |
| 15 | |
| 16 | /** |
| 17 | * Messenger method interface class |
| 18 | */ |
| 19 | interface messenger_interface |
| 20 | { |
| 21 | /** |
| 22 | * Check if the messenger method is enabled |
| 23 | * |
| 24 | * @return bool |
| 25 | */ |
| 26 | public function is_enabled(): bool; |
| 27 | |
| 28 | /** |
| 29 | * Set up subject for the message |
| 30 | * |
| 31 | * @param string $subject Email subject |
| 32 | * |
| 33 | * @return void |
| 34 | */ |
| 35 | public function subject(string $subject = ''): void; |
| 36 | |
| 37 | /** |
| 38 | * Send out messages |
| 39 | * |
| 40 | * @return bool |
| 41 | */ |
| 42 | public function send(): bool; |
| 43 | |
| 44 | /** |
| 45 | * Add error message to log |
| 46 | * |
| 47 | * @param string $msg Error message text |
| 48 | * |
| 49 | * @return void |
| 50 | */ |
| 51 | |
| 52 | public function error(string $msg): void; |
| 53 | |
| 54 | /** |
| 55 | * Add message header |
| 56 | * |
| 57 | * @param string $header_name Message header name |
| 58 | * @param mixed $header_value Message header value |
| 59 | * |
| 60 | * @return void |
| 61 | */ |
| 62 | public function header(string $header_name, mixed $header_value): void; |
| 63 | } |