Added missing node-id as this is needed in first announcement.

[hub.git] / application / hub / main / template / announcement / class_XmlAnnouncementTemplateEngine.php

diff --git a/application/hub/main/template/announcement/class_XmlAnnouncementTemplateEngine.php b/application/hub/main/template/announcement/class_XmlAnnouncementTemplateEngine.php
index 44c766e5004394bd0f40a475ef233bb562158cb9..dc2a479e87ecb0d5522726c83b957bf45bf3ccc3 100644 (file)
--- a/application/hub/main/template/announcement/class_XmlAnnouncementTemplateEngine.php
+++ b/application/hub/main/template/announcement/class_XmlAnnouncementTemplateEngine.php
@@ -2,11 +2,11 @@
 /**
  * An Announcement template engine class for XML templates
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
  * @license            GNU GPL 3.0 or any newer version
- * @link               http://www.ship-simu.org
+ * @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
@@ -26,12 +26,13 @@ class XmlAnnouncementTemplateEngine extends BaseXmlTemplateEngine implements Com
        /**
         * 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';
+       const ANNOUNCEMENT_DATA_SESSION_ID       = 'session-id';
+       const ANNOUNCEMENT_DATA_NODE_ID          = 'node-id';
+       const ANNOUNCEMENT_DATA_PRIVATE_KEY_HASH = 'private-key-hash';
+       const ANNOUNCEMENT_DATA_NODE_STATUS      = 'node-status';
+       const ANNOUNCEMENT_DATA_NODE_MODE        = 'node-mode';
+       const ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS = 'external-address';
+       const ANNOUNCEMENT_DATA_INTERNAL_ADDRESS = 'internal-address';
 
        /**
         * Protected constructor
@@ -43,17 +44,17 @@ class XmlAnnouncementTemplateEngine extends BaseXmlTemplateEngine implements Com
                parent::__construct(__CLASS__);
 
                // Init array
-               $this->subNodes = array(
+               $this->setSubNodes(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,
+                       self::ANNOUNCEMENT_DATA_PRIVATE_KEY_HASH,
+                       self::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS,
+                       self::ANNOUNCEMENT_DATA_INTERNAL_ADDRESS,
                        'object-type-list',
-               );
+               ));
        }
 
        /**
@@ -99,7 +100,7 @@ class XmlAnnouncementTemplateEngine extends BaseXmlTemplateEngine implements Com
                 * Assign the found characters to variable and use the last entry from
                 * stack as the name.
                 */
-               parent::assignVariable($this->getStackerInstance()->getNamed('node_announcement'), $characters);
+               parent::assignVariable($this->getStackInstance()->getNamed('node_announcement'), $characters);
        }
 
        /**
@@ -118,7 +119,7 @@ class XmlAnnouncementTemplateEngine extends BaseXmlTemplateEngine implements Com
         */
        protected function startAnnouncement () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('node_announcement', 'node_announcement');
+               $this->getStackInstance()->pushNamed('node_announcement', 'announcement');
        }
 
        /**
@@ -128,7 +129,7 @@ class XmlAnnouncementTemplateEngine extends BaseXmlTemplateEngine implements Com
         */
        protected function startAnnouncementData () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('node_announcement', 'announcement-data');
+               $this->getStackInstance()->pushNamed('node_announcement', 'announcement-data');
        }
 
        /**
@@ -138,7 +139,7 @@ class XmlAnnouncementTemplateEngine extends BaseXmlTemplateEngine implements Com
         */
        protected function startNodeStatus () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_NODE_STATUS);
+               $this->getStackInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_NODE_STATUS);
        }
 
        /**
@@ -148,7 +149,7 @@ class XmlAnnouncementTemplateEngine extends BaseXmlTemplateEngine implements Com
         */
        protected function startNodeMode () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_NODE_MODE);
+               $this->getStackInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_NODE_MODE);
        }
 
        /**
@@ -158,27 +159,27 @@ class XmlAnnouncementTemplateEngine extends BaseXmlTemplateEngine implements Com
         */
        protected function startListener () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('node_announcement', 'listener');
+               $this->getStackInstance()->pushNamed('node_announcement', 'listener');
        }
 
        /**
-        * Starts the TCP/UDP listen port
+        * Starts the session id
         *
         * @return      void
         */
-       protected function startListenPort () {
+       protected function startSessionId () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_LISTEN_PORT);
+               $this->getStackInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_SESSION_ID);
        }
 
        /**
-        * Starts the session id
+        * Starts the private key hash
         *
         * @return      void
         */
-       protected function startSessionId () {
+       protected function startPrivateKeyHash () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_SESSION_ID);
+               $this->getStackInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_PRIVATE_KEY_HASH);
        }
 
        /**
@@ -186,9 +187,9 @@ class XmlAnnouncementTemplateEngine extends BaseXmlTemplateEngine implements Com
         *
         * @return      void
         */
-       protected function startExternalIp () {
+       protected function startExternalAddress () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_EXTERNAL_IP);
+               $this->getStackInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS);
        }
 
        /**
@@ -196,9 +197,9 @@ class XmlAnnouncementTemplateEngine extends BaseXmlTemplateEngine implements Com
         *
         * @return      void
         */
-       protected function startInternalIp () {
+       protected function startInternalAddress () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_INTERNAL_IP);
+               $this->getStackInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_INTERNAL_ADDRESS);
        }
 
        /**
@@ -208,7 +209,7 @@ class XmlAnnouncementTemplateEngine extends BaseXmlTemplateEngine implements Com
         */
        protected function startObjectTypeList () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('node_announcement', 'object-type-list');
+               $this->getStackInstance()->pushNamed('node_announcement', 'object-type-list');
        }
 
        /**
@@ -218,7 +219,7 @@ class XmlAnnouncementTemplateEngine extends BaseXmlTemplateEngine implements Com
         */
        protected function startObjectType () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('node_announcement', 'object-type');
+               $this->getStackInstance()->pushNamed('node_announcement', 'object-type');
        }
 
        /**
@@ -228,7 +229,7 @@ class XmlAnnouncementTemplateEngine extends BaseXmlTemplateEngine implements Com
         */
        protected function finishObjectType () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('node_announcement');
+               $this->getStackInstance()->popNamed('node_announcement');
        }
 
        /**
@@ -238,47 +239,47 @@ class XmlAnnouncementTemplateEngine extends BaseXmlTemplateEngine implements Com
         */
        protected function finishObjectTypeList () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('node_announcement');
+               $this->getStackInstance()->popNamed('node_announcement');
        }
 
        /**
-        * Finishes the session id
+        * Finishes the private key hash
         *
         * @return      void
         */
-       protected function finishSessionId () {
+       protected function finishPrivateKeyHash () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('node_announcement');
+               $this->getStackInstance()->popNamed('node_announcement');
        }
 
        /**
-        * Finishes the private ip
+        * Finishes the session id
         *
         * @return      void
         */
-       protected function finishInternalIp () {
+       protected function finishSessionId () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('node_announcement');
+               $this->getStackInstance()->popNamed('node_announcement');
        }
 
        /**
-        * Finishes the public ip
+        * Finishes the private ip
         *
         * @return      void
         */
-       protected function finishExternalIp () {
+       protected function finishInternalAddress () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('node_announcement');
+               $this->getStackInstance()->popNamed('node_announcement');
        }
 
        /**
-        * Finishes the TCP/UDP listen port
+        * Finishes the public ip
         *
         * @return      void
         */
-       protected function finishListenPort () {
+       protected function finishExternalAddress () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('node_announcement');
+               $this->getStackInstance()->popNamed('node_announcement');
        }
 
        /**
@@ -288,7 +289,7 @@ class XmlAnnouncementTemplateEngine extends BaseXmlTemplateEngine implements Com
         */
        protected function finishListener () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('node_announcement');
+               $this->getStackInstance()->popNamed('node_announcement');
        }
 
        /**
@@ -298,7 +299,7 @@ class XmlAnnouncementTemplateEngine extends BaseXmlTemplateEngine implements Com
         */
        protected function finishNodeMode () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('node_announcement');
+               $this->getStackInstance()->popNamed('node_announcement');
        }
 
        /**
@@ -308,7 +309,7 @@ class XmlAnnouncementTemplateEngine extends BaseXmlTemplateEngine implements Com
         */
        protected function finishNodeStatus () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('node_announcement');
+               $this->getStackInstance()->popNamed('node_announcement');
        }
 
        /**
@@ -318,7 +319,7 @@ class XmlAnnouncementTemplateEngine extends BaseXmlTemplateEngine implements Com
         */
        protected function finishAnnouncementData () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('node_announcement');
+               $this->getStackInstance()->popNamed('node_announcement');
        }
 
        /**
@@ -328,7 +329,7 @@ class XmlAnnouncementTemplateEngine extends BaseXmlTemplateEngine implements Com
         */
        protected function finishAnnouncement () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('node_announcement');
+               $this->getStackInstance()->popNamed('node_announcement');
        }
 }