X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=application%2Fhub%2Fmain%2Ftemplate%2Fanswer%2Fannouncement%2Fclass_XmlAnnouncementAnswerTemplateEngine.php;h=d4f0dc738feb5291a01b3d09437e84388d45e16f;hb=0d4b1675b69d4f54e11e80af16027e15b8da4eb1;hp=36db7c1c715afd76f55e1b974bfb296e0578e752;hpb=8d6d2851977569eeb828eea22ea6fb5f53967930;p=hub.git diff --git a/application/hub/main/template/answer/announcement/class_XmlAnnouncementAnswerTemplateEngine.php b/application/hub/main/template/answer/announcement/class_XmlAnnouncementAnswerTemplateEngine.php index 36db7c1c7..d4f0dc738 100644 --- a/application/hub/main/template/answer/announcement/class_XmlAnnouncementAnswerTemplateEngine.php +++ b/application/hub/main/template/answer/announcement/class_XmlAnnouncementAnswerTemplateEngine.php @@ -1,12 +1,12 @@ + * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2014 Core 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 @@ -22,7 +22,7 @@ * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ -class XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements CompileableTemplate, Registerable { +class XmlAnnouncementAnswerTemplateEngine extends BaseXmlAnswerTemplateEngine implements CompileableTemplate, Registerable { /** * Some XML nodes must be available for later data extraction */ @@ -30,27 +30,7 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements 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'; - - /** - * Main nodes in the XML tree - */ - private $mainNodes = array( - 'announcement-answer' - ); - - /** - * Sub nodes in the XML tree - */ - private $subNodes = array( - ); - - /** - * Current main node - */ - private $curr = array(); + const ANNOUNCEMENT_DATA_LISTEN_PORT = 'my-listen-port'; /** * Protected constructor @@ -69,16 +49,15 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements // 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, ); } @@ -97,162 +76,13 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements // Get a new instance $templateInstance = new XmlAnnouncementAnswerTemplateEngine(); - // Get application instance from registry - $applicationInstance = Registry::getRegistry()->getInstance('app'); - - // Determine base path - $templateBasePath = $templateInstance->getConfigInstance()->getConfigEntry('application_base_path') . $applicationInstance->getRequestInstance()->getRequestElement('app') . '/'; - - // Is the base path valid? - if (empty($templateBasePath)) { - // Base path is empty - throw new BasePathIsEmptyException($templateInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING); - } elseif (!is_string($templateBasePath)) { - // Is not a string - throw new InvalidBasePathStringException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_STRING); - } elseif (!is_dir($templateBasePath)) { - // Is not a path - throw new BasePathIsNoDirectoryException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_PATH_NAME); - } elseif (!is_readable($templateBasePath)) { - // Is not readable - throw new BasePathReadProtectedException(array($templateInstance, $templateBasePath), self::EXCEPTION_READ_PROTECED_PATH); - } - - // Set the base path - $templateInstance->setTemplateBasePath($templateBasePath); - - // Set template extensions - $templateInstance->setRawTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('raw_template_extension')); - $templateInstance->setCodeTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('node_answer_template_extension')); - - // Absolute output path for compiled templates - $templateInstance->setCompileOutputPath($templateInstance->getConfigInstance()->getConfigEntry('base_path') . $templateInstance->getConfigInstance()->getConfigEntry('compile_output_path')); - - // Init a variable stacker - $stackerInstance = ObjectFactory::createObjectByConfiguredName('node_announcement_answer_stacker_class'); - - // Set it - $templateInstance->setStackerInstance($stackerInstance); + // Init instance + $templateInstance->initXmlTemplateEngine('node', 'announcement_answer'); // Return the prepared instance 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); - } - - /** - * Getter for current main node - * - * @return $currMainNode Current main node - */ - public final function getCurrMainNode () { - return $this->curr['main_node']; - } - - /** - * Setter for current main node - * - * @param $element Element name to set as current main node - * @return $currMainNode Current main node - */ - private final function setCurrMainNode ($element) { - $this->curr['main_node'] = (string) $element; - } - - /** - * Getter for main node array - * - * @return $mainNodes Array with valid main node names - */ - public final function getMainNodes () { - return $this->mainNodes; - } - - /** - * Getter for sub node array - * - * @return $subNodes Array with valid sub node names - */ - public final function getSubNodes () { - return $this->subNodes; - } - - /** - * Handles the start element of an XML resource - * - * @param $resource XML parser resource (currently ignored) - * @param $element The element we shall handle - * @param $attributes All attributes - * @return void - * @throws InvalidXmlNodeException If an unknown/invalid XML node name was found - */ - public function startElement ($resource, $element, array $attributes) { - // Initial method name which will never be called... - $methodName = 'initAnnouncementAnswer'; - - // Make the element name lower-case - $element = strtolower($element); - - // Is the element a main node? - //* DEBUG: */ echo "START: >".$element."<
\n"; - if (in_array($element, $this->getMainNodes())) { - // Okay, main node found! - $methodName = 'start' . $this->convertToClassName($element); - - // Set it - $this->setCurrMainNode($element); - } elseif (in_array($element, $this->getSubNodes())) { - // Sub node found - $methodName = 'start' . $this->convertToClassName($element); - } else { - // Invalid node name found - throw new InvalidXmlNodeException(array($this, $element, $attributes), XmlParser::EXCEPTION_XML_NODE_UNKNOWN); - } - - // Call method - call_user_func_array(array($this, $methodName), $attributes); - } - - /** - * Ends the main or sub node by sending out the gathered data - * - * @param $resource An XML resource pointer (currently ignored) - * @param $nodeName Name of the node we want to finish - * @return void - * @throws XmlNodeMismatchException If current main node mismatches the closing one - */ - public function endElement ($resource, $nodeName) { - // Make all lower-case - $nodeName = strtolower($nodeName); - - // Does this match with current main node? - //* DEBUG: */ echo "END: >".$nodeName."<
\n"; - if (($nodeName != $this->getCurrMainNode()) && (in_array($nodeName, $this->getMainNodes()))) { - // Did not match! - throw new XmlNodeMismatchException (array($this, $nodeName, $this->getCurrMainNode()), XmlParser::EXCEPTION_XML_NODE_MISMATCH); - } // END - if - - // Construct method name - $methodName = 'finish' . $this->convertToClassName($nodeName); - - // Call the corresponding method - //* DEBUG: */ echo "call: ".$methodName."
\n"; - call_user_func_array(array($this, $methodName), array()); - } - /** * Currently not used * @@ -268,29 +98,14 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements // Is this string empty? if (empty($characters)) { // Then skip it silently - return false; + return; } // END - if /* * 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->getStackInstance()->getNamed('node_announcement_answer'), $characters); } /** @@ -307,9 +122,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements * * @return void */ - private function startAnnouncementAnswer () { + protected function startAnnouncementAnswer () { // Push the node name on the stacker - $this->getStackerInstance()->pushNamed('announcement_answer', 'announcement-answer'); + $this->getStackInstance()->pushNamed('node_announcement_answer', 'announcement-answer'); } /** @@ -317,9 +132,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements * * @return void */ - private function startMyData () { + protected function startMyData () { // Push the node name on the stacker - $this->getStackerInstance()->pushNamed('announcement_answer', 'my-data'); + $this->getStackInstance()->pushNamed('node_announcement_answer', 'my-data'); } /** @@ -327,9 +142,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements * * @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->getStackInstance()->pushNamed('node_announcement_answer', self::ANNOUNCEMENT_DATA_EXTERNAL_IP); } /** @@ -337,9 +152,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements * * @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->getStackInstance()->pushNamed('node_announcement_answer', self::ANNOUNCEMENT_DATA_INTERNAL_IP); } /** @@ -347,19 +162,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements * * @return void */ - private function startMyTcpPort () { - // Push the node name on the stacker - $this->getStackerInstance()->pushNamed('announcement_answer', self::ANNOUNCEMENT_DATA_TCP_PORT); - } - - /** - * Starts the my-udp-port - * - * @return void - */ - private function startMyUdpPort () { + protected function startMyListenPort () { // Push the node name on the stacker - $this->getStackerInstance()->pushNamed('announcement_answer', self::ANNOUNCEMENT_DATA_UDP_PORT); + $this->getStackInstance()->pushNamed('node_announcement_answer', self::ANNOUNCEMENT_DATA_LISTEN_PORT); } /** @@ -367,9 +172,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements * * @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->getStackInstance()->pushNamed('node_announcement_answer', self::ANNOUNCEMENT_DATA_SESSION_ID); } /** @@ -377,9 +182,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements * * @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->getStackInstance()->pushNamed('node_announcement_answer', self::ANNOUNCEMENT_DATA_NODE_STATUS); } /** @@ -387,9 +192,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements * * @return void */ - private function finishMyStatus () { + protected function finishMyStatus () { // Pop the last entry - $this->getStackerInstance()->popNamed('announcement_answer'); + $this->getStackInstance()->popNamed('node_announcement_answer'); } /** @@ -397,19 +202,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements * * @return void */ - private function finishMySessionId () { - // Pop the last entry - $this->getStackerInstance()->popNamed('announcement_answer'); - } - - /** - * Finishes the my-udp-port - * - * @return void - */ - private function finishMyUdpPort () { + protected function finishMySessionId () { // Pop the last entry - $this->getStackerInstance()->popNamed('announcement_answer'); + $this->getStackInstance()->popNamed('node_announcement_answer'); } /** @@ -417,9 +212,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements * * @return void */ - private function finishMyTcpPort () { + protected function finishMyListenPort () { // Pop the last entry - $this->getStackerInstance()->popNamed('announcement_answer'); + $this->getStackInstance()->popNamed('node_announcement_answer'); } /** @@ -427,9 +222,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements * * @return void */ - private function finishMyInternalIp () { + protected function finishMyInternalIp () { // Pop the last entry - $this->getStackerInstance()->popNamed('announcement_answer'); + $this->getStackInstance()->popNamed('node_announcement_answer'); } /** @@ -437,9 +232,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements * * @return void */ - private function finishMyExternalIp () { + protected function finishMyExternalIp () { // Pop the last entry - $this->getStackerInstance()->popNamed('announcement_answer'); + $this->getStackInstance()->popNamed('node_announcement_answer'); } /** @@ -447,9 +242,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements * * @return void */ - private function finishMyData () { + protected function finishMyData () { // Pop the last entry - $this->getStackerInstance()->popNamed('announcement_answer'); + $this->getStackInstance()->popNamed('node_announcement_answer'); } /** @@ -457,9 +252,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements * * @return void */ - private function startYourData () { + protected function startYourData () { // Push the node name on the stacker - $this->getStackerInstance()->pushNamed('announcement_answer', 'your-data'); + $this->getStackInstance()->pushNamed('node_announcement_answer', 'your-data'); } /** @@ -467,9 +262,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements * * @return void */ - private function startYourExternalIp () { + protected function startYourExternalIp () { // Push the node name on the stacker - $this->getStackerInstance()->pushNamed('announcement_answer', 'your-external-ip'); + $this->getStackInstance()->pushNamed('node_announcement_answer', 'your-external-ip'); } /** @@ -477,9 +272,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements * * @return void */ - private function startYourInternalIp () { + protected function startYourInternalIp () { // Push the node name on the stacker - $this->getStackerInstance()->pushNamed('announcement_answer', 'your-internal-ip'); + $this->getStackInstance()->pushNamed('node_announcement_answer', 'your-internal-ip'); } /** @@ -487,9 +282,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements * * @return void */ - private function startYourSessionId () { + protected function startYourSessionId () { // Push the node name on the stacker - $this->getStackerInstance()->pushNamed('announcement_answer', 'your-session-id'); + $this->getStackInstance()->pushNamed('node_announcement_answer', 'your-session-id'); } /** @@ -497,9 +292,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements * * @return void */ - private function finishYourSessionId () { + protected function finishYourSessionId () { // Pop the last entry - $this->getStackerInstance()->popNamed('announcement_answer'); + $this->getStackInstance()->popNamed('node_announcement_answer'); } /** @@ -507,9 +302,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements * * @return void */ - private function finishYourInternalIp () { + protected function finishYourInternalIp () { // Pop the last entry - $this->getStackerInstance()->popNamed('announcement_answer'); + $this->getStackInstance()->popNamed('node_announcement_answer'); } /** @@ -517,9 +312,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements * * @return void */ - private function finishYourExternalIp () { + protected function finishYourExternalIp () { // Pop the last entry - $this->getStackerInstance()->popNamed('announcement_answer'); + $this->getStackInstance()->popNamed('node_announcement_answer'); } /** @@ -527,29 +322,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements * * @return void */ - private function finishYourData () { - // Pop the last entry - $this->getStackerInstance()->popNamed('announcement_answer'); - } - - /** - * Starts the answer-status - * - * @return void - */ - private 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 - */ - private function finishAnswerStatus () { + protected function finishYourData () { // Pop the last entry - $this->getStackerInstance()->popNamed('announcement_answer'); + $this->getStackInstance()->popNamed('node_announcement_answer'); } /** @@ -557,9 +332,9 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements * * @return void */ - private function finishAnnouncementAnswer () { + protected function finishAnnouncementAnswer () { // Pop the last entry - $this->getStackerInstance()->popNamed('announcement_answer'); + $this->getStackInstance()->popNamed('node_announcement_answer'); } }