Rewrites, some more methods:

[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 62fc3212c4398a05dc96383e229827e4fbbe0ab9..17feefd456b20ee14dad667ee2f53b4857260e0b 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
@@ -22,7 +22,7 @@
  * 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 XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implements CompileableTemplate, Registerable {
+class XmlAnnouncementAnswerTemplateEngine extends BaseXmlAnswerTemplateEngine implements CompileableTemplate, Registerable {
        /**
         * Some XML nodes must be available for later data extraction
         */
@@ -30,9 +30,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
        const ANNOUNCEMENT_DATA_NODE_STATUS   = 'my-status';
        const ANNOUNCEMENT_DATA_EXTERNAL_IP   = 'my-external-ip';
        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';
+       const ANNOUNCEMENT_DATA_LISTEN_PORT      = 'my-listen-port';
 
        /**
         * Protected constructor
@@ -51,16 +49,15 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
                        // Data from *this* node
                        self::ANNOUNCEMENT_DATA_EXTERNAL_IP,
                        self::ANNOUNCEMENT_DATA_INTERNAL_IP,
-                       self::ANNOUNCEMENT_DATA_TCP_PORT,
-                       self::ANNOUNCEMENT_DATA_UDP_PORT,
+                       self::ANNOUNCEMENT_DATA_LISTEN_PORT,
                        self::ANNOUNCEMENT_DATA_NODE_STATUS,
                        self::ANNOUNCEMENT_DATA_SESSION_ID,
                        // Data from other node
                        'your-external-ip',
                        'your-internal-ip',
                        'your-session-id',
-                       // Answer status (code)
-                       self::ANNOUNCEMENT_DATA_ANSWER_STATUS
+                       // Answer status (generic field)
+                       self::ANSWER_STATUS,
                );
        }
 
@@ -108,7 +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);
+               parent::assignVariable($this->getStackerInstance()->getNamed('node_announcement_answer'), $characters);
        }
 
        /**
@@ -127,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');
        }
 
        /**
@@ -137,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');
        }
 
        /**
@@ -147,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);
        }
 
        /**
@@ -157,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);
        }
 
        /**
@@ -165,19 +162,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         *
         * @return      void
         */
-       protected function startMyTcpPort () {
+       protected function startMyListenPort () {
                // Push the node name on the stacker
-               $this->getStackerInstance()->pushNamed('announcement_answer', self::ANNOUNCEMENT_DATA_TCP_PORT);
-       }
-
-       /**
-        * Starts the my-udp-port
-        *
-        * @return      void
-        */
-       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_LISTEN_PORT);
        }
 
        /**
@@ -187,7 +174,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);
        }
 
        /**
@@ -197,7 +184,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);
        }
 
        /**
@@ -207,7 +194,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function finishMyStatus () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -217,17 +204,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function finishMySessionId () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
-       }
-
-       /**
-        * Finishes the my-udp-port
-        *
-        * @return      void
-        */
-       protected function finishMyUdpPort () {
-               // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -235,9 +212,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         *
         * @return      void
         */
-       protected function finishMyTcpPort () {
+       protected function finishMyListenPort () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -247,7 +224,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function finishMyInternalIp () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -257,7 +234,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function finishMyExternalIp () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -267,7 +244,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function finishMyData () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -277,7 +254,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');
        }
 
        /**
@@ -287,7 +264,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');
        }
 
        /**
@@ -297,7 +274,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');
        }
 
        /**
@@ -307,7 +284,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');
        }
 
        /**
@@ -317,7 +294,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function finishYourSessionId () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -327,7 +304,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function finishYourInternalIp () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -337,7 +314,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function finishYourExternalIp () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 
        /**
@@ -347,27 +324,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');
        }
 
        /**
@@ -377,7 +334,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseXmlTemplateEngine implemen
         */
        protected function finishAnnouncementAnswer () {
                // Pop the last entry
-               $this->getStackerInstance()->popNamed('announcement_answer');
+               $this->getStackerInstance()->popNamed('node_announcement_answer');
        }
 }