Comment header cosmetics applied

[shipsimu.git] / inc / classes / main / mailer / debug / class_DebugMailer.php

diff --git a/inc/classes/main/mailer/debug/class_DebugMailer.php b/inc/classes/main/mailer/debug/class_DebugMailer.php
index 6437823bd87da7e14ac0344398db1060453c46df..ee6f3ee01d8c1c4e932c3d988a8212b39231f1b4 100644 (file)
--- a/inc/classes/main/mailer/debug/class_DebugMailer.php
+++ b/inc/classes/main/mailer/debug/class_DebugMailer.php
@@ -1,6 +1,7 @@
 <?php
 /**
- * 
+ * A mailer class for debugging purposes only. This class will print the
+ * prepared mail out and will not send it to the recipient.
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
@@ -19,7 +20,7 @@
  * GNU General Public License for more details.
  *
  * You should have received a copy of the GNU General Public License
- * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 class DebugMailer extends BaseMailer implements DeliverableMail {
        /**
@@ -41,15 +42,37 @@ class DebugMailer extends BaseMailer implements DeliverableMail {
        /**
         * Creates an instance of this mailer class
         *
+        * @param       $templateInstance       A template instance
         * @return      $mailerInstance         An instance of this mailer class
         */
-       public final static function createDebugMailer () {
+       public final static function createDebugMailer (CompileableTemplate $templateInstance) {
                // Get a new instance
                $mailerInstance = new DebugMailer();
 
+               // Set template instance
+               $mailerInstance->setTemplateInstance($templateInstance);
+
                // Return the instance
                return $mailerInstance;
        }
+
+       /**
+        * Deliver email to the recipient(s)
+        *
+        * @return      void
+        */
+       public function deliverEmail () {
+               $this->partialStub();
+       }
+
+       /**
+        * Send notification to the admin
+        *
+        * @return      void
+        */
+       public function sendAdminNotification () {
+               $this->partialStub();
+       }
 }
 
 // [EOF]