Added template class for entries in a request-node-list

[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 038c66e413c06ac82a8085f78933d21b76756752..0e2239426e6035cd5008300e6582d4894629d14f 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
@@ -86,21 +86,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 +108,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);
        }
 
        /**
@@ -155,9 +125,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         *
         * @return      void
         */
-       private function startAnnouncementAnswer () {
+       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');
        }
 
        /**
@@ -165,9 +135,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         *
         * @return      void
         */
-       private function startMyData () {
+       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');
        }
 
        /**
@@ -175,9 +145,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         *
         * @return      void
         */
-       private function startMyExternalIp () {
+       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);
        }
 
        /**
@@ -185,9 +155,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         *
         * @return      void
         */
-       private function startMyInternalIp () {
+       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);
        }
 
        /**
@@ -195,9 +165,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         *
         * @return      void
         */
-       private function startMyTcpPort () {
+       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);
        }
 
        /**
@@ -205,9 +175,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         *
         * @return      void
         */
-       private function startMyUdpPort () {
+       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);
        }
 
        /**
@@ -215,9 +185,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         *
         * @return      void
         */
-       private function startMySessionId () {
+       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);
        }
 
        /**
@@ -225,9 +195,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         *
         * @return      void
         */
-       private function startMyStatus () {
+       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);
        }
 
        /**
@@ -235,9 +205,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         *
         * @return      void
         */
-       private function finishMyStatus () {
+       protected function finishMyStatus () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -245,9 +215,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         *
         * @return      void
         */
-       private function finishMySessionId () {
+       protected function finishMySessionId () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -255,9 +225,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         *
         * @return      void
         */
-       private function finishMyUdpPort () {
+       protected function finishMyUdpPort () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -265,9 +235,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         *
         * @return      void
         */
-       private function finishMyTcpPort () {
+       protected function finishMyTcpPort () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -275,9 +245,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         *
         * @return      void
         */
-       private function finishMyInternalIp () {
+       protected function finishMyInternalIp () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -285,9 +255,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         *
         * @return      void
         */
-       private function finishMyExternalIp () {
+       protected function finishMyExternalIp () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -295,9 +265,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         *
         * @return      void
         */
-       private function finishMyData () {
+       protected function finishMyData () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -305,9 +275,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         *
         * @return      void
         */
-       private function startYourData () {
+       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');
        }
 
        /**
@@ -315,9 +285,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         *
         * @return      void
         */
-       private function startYourExternalIp () {
+       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');
        }
 
        /**
@@ -325,9 +295,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         *
         * @return      void
         */
-       private function startYourInternalIp () {
+       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');
        }
 
        /**
@@ -335,9 +305,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         *
         * @return      void
         */
-       private function startYourSessionId () {
+       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');
        }
 
        /**
@@ -345,9 +315,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         *
         * @return      void
         */
-       private function finishYourSessionId () {
+       protected function finishYourSessionId () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -355,9 +325,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         *
         * @return      void
         */
-       private function finishYourInternalIp () {
+       protected function finishYourInternalIp () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -365,9 +335,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         *
         * @return      void
         */
-       private function finishYourExternalIp () {
+       protected function finishYourExternalIp () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -375,9 +345,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         *
         * @return      void
         */
-       private function finishYourData () {
+       protected function finishYourData () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -385,9 +355,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         *
         * @return      void
         */
-       private function startAnswerStatus () {
+       protected function startAnswerStatus () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('announcement_answer', self::ANNOUNCEMENT_DATA_ANSWER_STATUS);
+               $this->getStackerInstance()->pushNamed('node_announcement_answer', self::ANNOUNCEMENT_DATA_ANSWER_STATUS);
        }
 
        /**
@@ -395,9 +365,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         *
         * @return      void
         */
-       private function finishAnswerStatus () {
+       protected function finishAnswerStatus () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -405,9 +375,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         *
         * @return      void
         */
-       private function finishAnnouncementAnswer () {
+       protected function finishAnnouncementAnswer () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 }