Continued:
[core.git] / framework / main / classes / mailer / class_
1 <?php
2 // Own namespace
3 namespace CoreFramework\Mailer\!!!;
4
5 // Import framwork stuff
6 use CoreFramework\Mailer\BaseMailer;
7 use CoreFramework\Mailer\DeliverableMail;
8
9 /**
10  * A ??? mailer class
11  *
12  * @author              Roland Haeder <webmaster@ship-simu.org>
13  * @version             0.0.0
14  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
15  * @license             GNU GPL 3.0 or any newer version
16  * @link                http://www.ship-simu.org
17  *
18  * This program is free software: you can redistribute it and/or modify
19  * it under the terms of the GNU General Public License as published by
20  * the Free Software Foundation, either version 3 of the License, or
21  * (at your option) any later version.
22  *
23  * This program is distributed in the hope that it will be useful,
24  * but WITHOUT ANY WARRANTY; without even the implied warranty of
25  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
26  * GNU General Public License for more details.
27  *
28  * You should have received a copy of the GNU General Public License
29  * along with this program. If not, see <http://www.gnu.org/licenses/>.
30  */
31 class ???Mailer extends BaseMailer implements DeliverableMail {
32         /**
33          * Protected constructor
34          *
35          * @return      void
36          */
37         protected function __construct () {
38                 // Call parent constructor
39                 parent::__construct(__CLASS__);
40         }
41
42         /**
43          * Creates an instance of this mailer class
44          *
45          * @return      $mailerInstance         An instance of this mailer class
46          */
47         public final static function create???Mailer () {
48                 // Get a new instance
49                 $mailerInstance = new ???Mailer();
50
51                 // Return the instance
52                 return $mailerInstance;
53         }
54
55         /**
56          * Deliver email to the recipient(s)
57          *
58          * @return      void
59          * @todo        0% done
60          */
61         public function deliverEmail() {
62                 $this->partialStub("You have to implement this method.");
63         }
64
65         /**
66          * Send notification to the admin
67          *
68          * @return      void
69          * @todo        0% done
70          */
71         public function sendAdminNotification() {
72                 $this->partialStub("You have to implement this method.");
73         }
74
75 }