<?php
/**
 * An Announcement template engine class for XML templates
 *
 * @author		Roland Haeder <webmaster@shipsimu.org>
 * @version		0.0.0
 * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
 * @license		GNU GPL 3.0 or any newer version
 * @link		http://www.shipsimu.org
 * @todo		This template engine does not make use of setTemplateType()
 *
 * 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 XmlAnnouncementTemplateEngine extends BaseXmlTemplateEngine implements CompileableTemplate, Registerable {
	/**
	 * Some XML nodes must be available for later data extraction
	 */
	const ANNOUNCEMENT_DATA_SESSION_ID  = 'session-id';
	const ANNOUNCEMENT_DATA_NODE_STATUS = 'node-status';
	const ANNOUNCEMENT_DATA_NODE_MODE   = 'node-mode';
	const ANNOUNCEMENT_DATA_EXTERNAL_IP = 'external-ip';
	const ANNOUNCEMENT_DATA_INTERNAL_IP = 'internal-ip';
	const ANNOUNCEMENT_DATA_LISTEN_PORT = 'listen-port';

	/**
	 * Protected constructor
	 *
	 * @return	void
	 */
	protected function __construct () {
		// Call parent constructor
		parent::__construct(__CLASS__);

		// Init array
		$this->subNodes = array(
			'announcement-data',
			'listener',
			self::ANNOUNCEMENT_DATA_NODE_STATUS,
			self::ANNOUNCEMENT_DATA_NODE_MODE,
			self::ANNOUNCEMENT_DATA_LISTEN_PORT,
			self::ANNOUNCEMENT_DATA_SESSION_ID,
			self::ANNOUNCEMENT_DATA_EXTERNAL_IP,
			self::ANNOUNCEMENT_DATA_INTERNAL_IP,
			'object-type-list',
		);
	}

	/**
	 * Creates an instance of the class TemplateEngine and prepares it for usage
	 *
	 * @return	$templateInstance		An instance of TemplateEngine
	 * @throws	BasePathIsEmptyException		If the provided $templateBasePath is empty
	 * @throws	InvalidBasePathStringException	If $templateBasePath is no string
	 * @throws	BasePathIsNoDirectoryException	If $templateBasePath is no
	 *											directory or not found
	 * @throws	BasePathReadProtectedException	If $templateBasePath is
	 *											read-protected
	 */
	public static final function createXmlAnnouncementTemplateEngine () {
		// Get a new instance
		$templateInstance = new XmlAnnouncementTemplateEngine();

		// Init template instance
		$templateInstance->initXmlTemplateEngine('node', 'announcement');

		// Return the prepared instance
		return $templateInstance;
	}

	/**
	 * Currently not used
	 *
	 * @param	$resource		XML parser resource (currently ignored)
	 * @param	$characters		Characters to handle
	 * @return	void
	 */
	public function characterHandler ($resource, $characters) {
		// Trim all spaces away
		$characters = trim($characters);

		// Is this string empty?
		if (empty($characters)) {
			// Then skip it silently
			return;
		} // END - if

		/*
		 * Assign the found characters to variable and use the last entry from
		 * stack as the name.
		 */
		parent::assignVariable($this->getStackerInstance()->getNamed('node_announcement'), $characters);
	}

	/**
	 * Getter for cache file (FQFN)
	 *
	 * @return	$fqfn	Full-qualified file name of the menu cache
	 */
	public function getMenuCacheFqfn () {
		$this->partialStub('Please implement this method.');
	}

	/**
	 * Starts the announcement
	 *
	 * @return	void
	 */
	protected function startAnnouncement () {
		// Push the node name on the stacker
		$this->getStackerInstance()->pushNamed('node_announcement', 'node_announcement');
	}

	/**
	 * Starts the announcement data
	 *
	 * @return	void
	 */
	protected function startAnnouncementData () {
		// Push the node name on the stacker
		$this->getStackerInstance()->pushNamed('node_announcement', 'announcement-data');
	}

	/**
	 * Starts the node status
	 *
	 * @return	void
	 */
	protected function startNodeStatus () {
		// Push the node name on the stacker
		$this->getStackerInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_NODE_STATUS);
	}

	/**
	 * Starts the node-mode
	 *
	 * @return	void
	 */
	protected function startNodeMode () {
		// Push the node name on the stacker
		$this->getStackerInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_NODE_MODE);
	}

	/**
	 * Starts the listener
	 *
	 * @return	void
	 */
	protected function startListener () {
		// Push the node name on the stacker
		$this->getStackerInstance()->pushNamed('node_announcement', 'listener');
	}

	/**
	 * Starts the TCP/UDP listen port
	 *
	 * @return	void
	 */
	protected function startListenPort () {
		// Push the node name on the stacker
		$this->getStackerInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_LISTEN_PORT);
	}

	/**
	 * Starts the session id
	 *
	 * @return	void
	 */
	protected function startSessionId () {
		// Push the node name on the stacker
		$this->getStackerInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_SESSION_ID);
	}

	/**
	 * Starts the public ip
	 *
	 * @return	void
	 */
	protected function startExternalIp () {
		// Push the node name on the stacker
		$this->getStackerInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_EXTERNAL_IP);
	}

	/**
	 * Starts the private ip
	 *
	 * @return	void
	 */
	protected function startInternalIp () {
		// Push the node name on the stacker
		$this->getStackerInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_INTERNAL_IP);
	}

	/**
	 * Starts the object type list
	 *
	 * @return	void
	 */
	protected function startObjectTypeList () {
		// Push the node name on the stacker
		$this->getStackerInstance()->pushNamed('node_announcement', 'object-type-list');
	}

	/**
	 * Starts the object type
	 *
	 * @return	void
	 */
	protected function startObjectType () {
		// Push the node name on the stacker
		$this->getStackerInstance()->pushNamed('node_announcement', 'object-type');
	}

	/**
	 * Finishes the object type
	 *
	 * @return	void
	 */
	protected function finishObjectType () {
		// Pop the last entry
		$this->getStackerInstance()->popNamed('node_announcement');
	}

	/**
	 * Finishes the object type list
	 *
	 * @return	void
	 */
	protected function finishObjectTypeList () {
		// Pop the last entry
		$this->getStackerInstance()->popNamed('node_announcement');
	}

	/**
	 * Finishes the session id
	 *
	 * @return	void
	 */
	protected function finishSessionId () {
		// Pop the last entry
		$this->getStackerInstance()->popNamed('node_announcement');
	}

	/**
	 * Finishes the private ip
	 *
	 * @return	void
	 */
	protected function finishInternalIp () {
		// Pop the last entry
		$this->getStackerInstance()->popNamed('node_announcement');
	}

	/**
	 * Finishes the public ip
	 *
	 * @return	void
	 */
	protected function finishExternalIp () {
		// Pop the last entry
		$this->getStackerInstance()->popNamed('node_announcement');
	}

	/**
	 * Finishes the TCP/UDP listen port
	 *
	 * @return	void
	 */
	protected function finishListenPort () {
		// Pop the last entry
		$this->getStackerInstance()->popNamed('node_announcement');
	}

	/**
	 * Finishes the listener
	 *
	 * @return	void
	 */
	protected function finishListener () {
		// Pop the last entry
		$this->getStackerInstance()->popNamed('node_announcement');
	}

	/**
	 * Finishes the node mode
	 *
	 * @return	void
	 */
	protected function finishNodeMode () {
		// Pop the last entry
		$this->getStackerInstance()->popNamed('node_announcement');
	}

	/**
	 * Finishes the node status
	 *
	 * @return	void
	 */
	protected function finishNodeStatus () {
		// Pop the last entry
		$this->getStackerInstance()->popNamed('node_announcement');
	}

	/**
	 * Finishes the announcement data
	 *
	 * @return	void
	 */
	protected function finishAnnouncementData () {
		// Pop the last entry
		$this->getStackerInstance()->popNamed('node_announcement');
	}

	/**
	 * Finishes the announcement
	 *
	 * @return	void
	 */
	protected function finishAnnouncement () {
		// Pop the last entry
		$this->getStackerInstance()->popNamed('node_announcement');
	}
}

// [EOF]
?>