Updated 'core'.

[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 0ca17982afb6a8c5b29132e3432f1329cfb42d2d..5c528e8522d5f20b4806a46ac3ca40b49b27d34e 100644 (file)
--- a/application/hub/main/template/announcement/class_XmlAnnouncementTemplateEngine.php
+++ b/application/hub/main/template/announcement/class_XmlAnnouncementTemplateEngine.php
@@ -4,7 +4,7 @@
  *
  * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 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.shipsimu.org
  * @todo               This template engine does not make use of setTemplateType()
@@ -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,18 @@ 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_NODE_ID,
                        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',
-               );
+               ));
        }
 
        /**
@@ -162,23 +164,33 @@ class XmlAnnouncementTemplateEngine extends BaseXmlTemplateEngine implements Com
        }
 
        /**
-        * 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->getStackInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_LISTEN_PORT);
+               $this->getStackInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_SESSION_ID);
        }
 
        /**
-        * Starts the session id
+        * Starts the node id
         *
         * @return      void
         */
-       protected function startSessionId () {
+       protected function startNodeId () {
                // Push the node name on the stacker
-               $this->getStackInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_SESSION_ID);
+               $this->getStackInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_NODE_ID);
+       }
+
+       /**
+        * Starts the private key hash
+        *
+        * @return      void
+        */
+       protected function startPrivateKeyHash () {
+               // Push the node name on the stacker
+               $this->getStackInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_PRIVATE_KEY_HASH);
        }
 
        /**
@@ -186,9 +198,9 @@ class XmlAnnouncementTemplateEngine extends BaseXmlTemplateEngine implements Com
         *
         * @return      void
         */
-       protected function startExternalIp () {
+       protected function startExternalAddress () {
                // Push the node name on the stacker
-               $this->getStackInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_EXTERNAL_IP);
+               $this->getStackInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS);
        }
 
        /**
@@ -196,9 +208,9 @@ class XmlAnnouncementTemplateEngine extends BaseXmlTemplateEngine implements Com
         *
         * @return      void
         */
-       protected function startInternalIp () {
+       protected function startInternalAddress () {
                // Push the node name on the stacker
-               $this->getStackInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_INTERNAL_IP);
+               $this->getStackInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_INTERNAL_ADDRESS);
        }
 
        /**
@@ -242,41 +254,51 @@ class XmlAnnouncementTemplateEngine extends BaseXmlTemplateEngine implements Com
        }
 
        /**
-        * Finishes the session id
+        * Finishes the private key hash
         *
         * @return      void
         */
-       protected function finishSessionId () {
+       protected function finishPrivateKeyHash () {
                // Pop the last entry
                $this->getStackInstance()->popNamed('node_announcement');
        }
 
        /**
-        * Finishes the private ip
+        * Finishes the node id
         *
         * @return      void
         */
-       protected function finishInternalIp () {
+       protected function finishNodeId () {
                // Pop the last entry
                $this->getStackInstance()->popNamed('node_announcement');
        }
 
        /**
-        * Finishes the public ip
+        * Finishes the session id
+        *
+        * @return      void
+        */
+       protected function finishSessionId () {
+               // Pop the last entry
+               $this->getStackInstance()->popNamed('node_announcement');
+       }
+
+       /**
+        * Finishes the private ip
         *
         * @return      void
         */
-       protected function finishExternalIp () {
+       protected function finishInternalAddress () {
                // Pop the last entry
                $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->getStackInstance()->popNamed('node_announcement');
        }