framework/main/classes/mailer/class_

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