template.php
66 lines
| 1 | <?php |
| 2 | /** |
| 3 | * @package VikAppointments |
| 4 | * @subpackage core |
| 5 | * @author E4J s.r.l. |
| 6 | * @copyright Copyright (C) 2021 E4J s.r.l. All Rights Reserved. |
| 7 | * @license http://www.gnu.org/licenses/gpl-2.0.html GNU/GPL |
| 8 | * @link https://vikwp.com |
| 9 | */ |
| 10 | |
| 11 | // No direct access |
| 12 | defined('ABSPATH') or die('No script kiddies please!'); |
| 13 | |
| 14 | /** |
| 15 | * Interface used to handle mail templates entities. |
| 16 | * |
| 17 | * @since 1.7 |
| 18 | */ |
| 19 | interface VAPMailTemplate |
| 20 | { |
| 21 | /** |
| 22 | * Returns the code of the template before being parsed. |
| 23 | * |
| 24 | * @param string $file An optional template file to use. If not specified, |
| 25 | * the one set in configuration will be used. |
| 26 | * |
| 27 | * @return void |
| 28 | */ |
| 29 | public function setFile($file); |
| 30 | |
| 31 | /** |
| 32 | * Returns the code of the template before being parsed. |
| 33 | * |
| 34 | * @return string |
| 35 | */ |
| 36 | public function getTemplate(); |
| 37 | |
| 38 | /** |
| 39 | * Fetches the subject to be used in the e-mail. |
| 40 | * |
| 41 | * @return string |
| 42 | */ |
| 43 | public function getSubject(); |
| 44 | |
| 45 | /** |
| 46 | * Parses the HTML of the template and returns it. |
| 47 | * |
| 48 | * @return string |
| 49 | */ |
| 50 | public function getHtml(); |
| 51 | |
| 52 | /** |
| 53 | * Sends the HTML contents via e-mail. |
| 54 | * |
| 55 | * @return boolean |
| 56 | */ |
| 57 | public function send(); |
| 58 | |
| 59 | /** |
| 60 | * Checks whether the notification should be sent. |
| 61 | * |
| 62 | * @return boolean |
| 63 | */ |
| 64 | public function shouldSend(); |
| 65 | } |
| 66 |