<?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
 * @copyright	Copyright (c) 2007, 2008 Roland Haeder, this is free software
 * @license		GNU GPL 3.0 or any newer version
 * @link		http://www.ship-simu.org
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * 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/>.
 */
class DebugMailer extends BaseMailer implements DeliverableMail {
	/**
	 * Protected constructor
	 *
	 * @return	void
	 */
	protected function __construct () {
		// Call parent constructor
		parent::__construct(__CLASS__);

		// Set part description
		$this->setObjectDescription("A mailer for debugging purposes");

		// Create unique ID number
		$this->generateUniqueId();
	}

	/**
	 * 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 (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]
?>