inc/classes/main/mailer/debug/class_DebugMailer.php

   1 <?php
   2 /**
   3  * A mailer class for debugging purposes only. This class will print the
   4  * prepared mail out and will not send it to the recipient.
   5  *
   6  * @author              Roland Haeder <webmaster@ship-simu.org>
   7  * @version             0.0.0
   8  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
   9  * @license             GNU GPL 3.0 or any newer version
  10  * @link                http://www.ship-simu.org
  11  *
  12  * This program is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation, either version 3 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  24  */
  25 class DebugMailer extends BaseMailer implements DeliverableMail {
  26         /**
  27          * Protected constructor
  28          *
  29          * @return      void
  30          */
  31         protected function __construct () {
  32                 // Call parent constructor
  33                 parent::__construct(__CLASS__);
  34
  35                 // Set part description
  36                 $this->setObjectDescription("A mailer for debugging purposes");
  37
  38                 // Create unique ID number
  39                 $this->generateUniqueId();
  40         }
  41
  42         /**
  43          * Creates an instance of this mailer class
  44          *
  45          * @param       $templateInstance       A template instance
  46          * @return      $mailerInstance         An instance of this mailer class
  47          */
  48         public final static function createDebugMailer (CompileableTemplate $templateInstance) {
  49                 // Get a new instance
  50                 $mailerInstance = new DebugMailer();
  51
  52                 // Set template instance
  53                 $mailerInstance->setTemplateInstance($templateInstance);
  54
  55                 // Return the instance
  56                 return $mailerInstance;
  57         }
  58
  59         /**
  60          * Deliver email to the recipient(s)
  61          *
  62          * @return      void
  63          */
  64         public function deliverEmail () {
  65                 $this->partialStub();
  66         }
  67
  68         /**
  69          * Send notification to the admin
  70          *
  71          * @return      void
  72          */
  73         public function sendAdminNotification () {
  74                 $this->partialStub();
  75         }
  76 }
  77
  78 // [EOF]
  79 ?>