Field answer_status becomes more generic now

[hub.git] / application / hub / main / template / answer / announcement / class_XmlAnnouncementAnswerTemplateEngine.php

diff --git a/application/hub/main/template/answer/announcement/class_XmlAnnouncementAnswerTemplateEngine.php b/application/hub/main/template/answer/announcement/class_XmlAnnouncementAnswerTemplateEngine.php
index e5603fccaec98f6b9d9ef2c0fc88e210b7189659..953d681308a3e785b6afa31715df344d3a4c1b20 100644 (file)
--- a/application/hub/main/template/answer/announcement/class_XmlAnnouncementAnswerTemplateEngine.php
+++ b/application/hub/main/template/answer/announcement/class_XmlAnnouncementAnswerTemplateEngine.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * An ??? template engine class for XML templates
+ * An AnnouncementAnswer template engine class for XML templates
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
@@ -32,7 +32,6 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
        const ANNOUNCEMENT_DATA_INTERNAL_IP   = 'my-internal-ip';
        const ANNOUNCEMENT_DATA_TCP_PORT      = 'my-tcp-port';
        const ANNOUNCEMENT_DATA_UDP_PORT      = 'my-udp-port';
-       const ANNOUNCEMENT_DATA_ANSWER_STATUS = 'answer-status';
 
        /**
         * Protected constructor
@@ -59,8 +58,6 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
                        'your-external-ip',
                        'your-internal-ip',
                        'your-session-id',
-                       // Answer status (code)
-                       self::ANNOUNCEMENT_DATA_ANSWER_STATUS
                );
        }
 
@@ -86,21 +83,6 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
                return $templateInstance;
        }
 
-       /**
-        * Load a specified announcement-answer template into the engine
-        *
-        * @param       $template       The announcement-answer template we shall load which is
-        *                                              located in 'announcement_answer' by default
-        * @return      void
-        */
-       public function loadAnnouncementAnswerTemplate ($template = 'announcement_answer') {
-               // Set template type
-               $this->setTemplateType($this->getConfigInstance()->getConfigEntry('node_announcement_answer_template_type'));
-
-               // Load the special template
-               $this->loadTemplate($template);
-       }
-
        /**
         * Currently not used
         *
@@ -123,22 +105,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
                 * Assign the found characters to variable and use the last entry from
                 * stack as the name.
                 */
-               parent::assignVariable($this->getStackerInstance()->getNamed('announcement_answer'), $characters);
-       }
-
-       /**
-        * Read announcement-answer variables by calling readVariable() with 'general' as
-        * variable stack.
-        *
-        * @param       $key    Key to read from
-        * @return      $value  Value from variable
-        */
-       public function readAnnouncementAnswerData ($key) {
-               // Read the variable
-               $value = parent::readVariable($key, 'general');
-
-               // Return value
-               return $value;
+               parent::assignVariable($this->getStackerInstance()->getNamed('node_announcement_answer'), $characters);
        }
 
        /**
@@ -157,7 +124,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function startAnnouncementAnswer () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('announcement_answer', 'announcement-answer');
+               $this->getStackerInstance()->pushNamed('node_announcement_answer', 'announcement-answer');
        }
 
        /**
@@ -167,7 +134,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function startMyData () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('announcement_answer', 'my-data');
+               $this->getStackerInstance()->pushNamed('node_announcement_answer', 'my-data');
        }
 
        /**
@@ -177,7 +144,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function startMyExternalIp () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('announcement_answer', self::ANNOUNCEMENT_DATA_EXTERNAL_IP);
+               $this->getStackerInstance()->pushNamed('node_announcement_answer', self::ANNOUNCEMENT_DATA_EXTERNAL_IP);
        }
 
        /**
@@ -187,7 +154,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function startMyInternalIp () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('announcement_answer', self::ANNOUNCEMENT_DATA_INTERNAL_IP);
+               $this->getStackerInstance()->pushNamed('node_announcement_answer', self::ANNOUNCEMENT_DATA_INTERNAL_IP);
        }
 
        /**
@@ -197,7 +164,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function startMyTcpPort () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('announcement_answer', self::ANNOUNCEMENT_DATA_TCP_PORT);
+               $this->getStackerInstance()->pushNamed('node_announcement_answer', self::ANNOUNCEMENT_DATA_TCP_PORT);
        }
 
        /**
@@ -207,7 +174,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function startMyUdpPort () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('announcement_answer', self::ANNOUNCEMENT_DATA_UDP_PORT);
+               $this->getStackerInstance()->pushNamed('node_announcement_answer', self::ANNOUNCEMENT_DATA_UDP_PORT);
        }
 
        /**
@@ -217,7 +184,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function startMySessionId () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('announcement_answer', self::ANNOUNCEMENT_DATA_SESSION_ID);
+               $this->getStackerInstance()->pushNamed('node_announcement_answer', self::ANNOUNCEMENT_DATA_SESSION_ID);
        }
 
        /**
@@ -227,7 +194,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function startMyStatus () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('announcement_answer', self::ANNOUNCEMENT_DATA_NODE_STATUS);
+               $this->getStackerInstance()->pushNamed('node_announcement_answer', self::ANNOUNCEMENT_DATA_NODE_STATUS);
        }
 
        /**
@@ -237,7 +204,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function finishMyStatus () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -247,7 +214,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function finishMySessionId () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -257,7 +224,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function finishMyUdpPort () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -267,7 +234,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function finishMyTcpPort () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -277,7 +244,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function finishMyInternalIp () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -287,7 +254,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function finishMyExternalIp () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -297,7 +264,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function finishMyData () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -307,7 +274,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function startYourData () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('announcement_answer', 'your-data');
+               $this->getStackerInstance()->pushNamed('node_announcement_answer', 'your-data');
        }
 
        /**
@@ -317,7 +284,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function startYourExternalIp () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('announcement_answer', 'your-external-ip');
+               $this->getStackerInstance()->pushNamed('node_announcement_answer', 'your-external-ip');
        }
 
        /**
@@ -327,7 +294,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function startYourInternalIp () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('announcement_answer', 'your-internal-ip');
+               $this->getStackerInstance()->pushNamed('node_announcement_answer', 'your-internal-ip');
        }
 
        /**
@@ -337,7 +304,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function startYourSessionId () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('announcement_answer', 'your-session-id');
+               $this->getStackerInstance()->pushNamed('node_announcement_answer', 'your-session-id');
        }
 
        /**
@@ -347,7 +314,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function finishYourSessionId () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -357,7 +324,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function finishYourInternalIp () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -367,7 +334,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function finishYourExternalIp () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -377,27 +344,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function finishYourData () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
-       }
-
-       /**
-        * Starts the answer-status
-        *
-        * @return      void
-        */
-       protected function startAnswerStatus () {
-               // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('announcement_answer', self::ANNOUNCEMENT_DATA_ANSWER_STATUS);
-       }
-
-       /**
-        * Finishes the answer-status
-        *
-        * @return      void
-        */
-       protected function finishAnswerStatus () {
-               // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -407,7 +354,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function finishAnnouncementAnswer () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 }