X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=application%2Fhub%2Fmain%2Ftemplate%2Fanswer%2Fannouncement%2Fclass_XmlAnnouncementAnswerTemplateEngine.php;h=f70a05f554e587e0b46db912e86b5d4660845160;hb=c0d1995cfe9a8bce7e30f3415a6bbefad49df838;hp=d8fdc010fde7bfa35551651a4bb7cc0e53c752a2;hpb=3fd5a3439a45dbc73c7375140f2f8166a4c4fa7e;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 d8fdc010f..f70a05f55 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,40 +22,14 @@ * 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 { /** - * Main nodes in the XML tree + * Some XML nodes must be available for later data extraction */ - private $mainNodes = array( - 'announcement-answer' - ); - - /** - * Sub nodes in the XML tree - */ - private $subNodes = array( - // These nodes don't contain any data - 'node-data', - 'other-data', - // Data from *this* node - 'node-external-ip', - 'node-internal-ip', - 'node-tcp-port', - 'node-udp-port', - 'node-session-id', - 'node-status', - // Data from other node - 'other-external-ip', - 'other-internal-ip', - 'other-session-id', - // Answer status (code) - 'answer-status' - ); - - /** - * Current main node - */ - private $curr = array(); + const ANNOUNCEMENT_DATA_SESSION_ID = 'my-session-id'; + const ANNOUNCEMENT_DATA_NODE_STATUS = 'my-status'; + const ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS = 'my-external-address'; + const ANNOUNCEMENT_DATA_INTERNAL_ADDRESS = 'my-internal-address'; /** * Protected constructor @@ -65,6 +39,24 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements protected function __construct () { // Call parent constructor parent::__construct(__CLASS__); + + // Init sub-nodes array + $this->subNodes = array( + // These nodes don't contain any data + 'my-data', + 'your-data', + // Data from *this* node + self::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS, + self::ANNOUNCEMENT_DATA_INTERNAL_ADDRESS, + self::ANNOUNCEMENT_DATA_NODE_STATUS, + self::ANNOUNCEMENT_DATA_SESSION_ID, + // Data from other node + 'your-external-address', + 'your-internal-address', + 'your-session-id', + // Answer status (generic field) + self::ANSWER_STATUS, + ); } /** @@ -82,162 +74,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 * @@ -253,14 +96,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); + parent::assignVariable($this->getStackInstance()->getNamed('node_announcement_answer'), $characters); } /** @@ -277,249 +120,189 @@ class XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements * * @return void */ - private function startAnnouncementAnswer () { - // Push the node name on the stacker - $this->getStackerInstance()->pushNamed('announcement_answer', 'announcement-answer'); - } - - /** - * Starts the node-data - * - * @return void - */ - private function startNodeData () { + protected function startAnnouncementAnswer () { // Push the node name on the stacker - $this->getStackerInstance()->pushNamed('announcement_answer', 'node-data'); + $this->getStackInstance()->pushNamed('node_announcement_answer', 'announcement-answer'); } /** - * Starts the node-external-ip + * Starts the my-data * * @return void */ - private function startNodeExternalIp () { + protected function startMyData () { // Push the node name on the stacker - $this->getStackerInstance()->pushNamed('announcement_answer', 'node-external-ip'); + $this->getStackInstance()->pushNamed('node_announcement_answer', 'my-data'); } /** - * Starts the node-internal-ip + * Starts the my-external-address * * @return void */ - private function startNodeInternalIp () { + protected function startMyExternalAddress () { // Push the node name on the stacker - $this->getStackerInstance()->pushNamed('announcement_answer', 'node-internal-ip'); + $this->getStackInstance()->pushNamed('node_announcement_answer', self::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS); } /** - * Starts the node-tcp-port + * Starts the my-internal-address * * @return void */ - private function startNodeTcpPort () { + protected function startMyInternalAddress () { // Push the node name on the stacker - $this->getStackerInstance()->pushNamed('announcement_answer', 'node-tcp-port'); + $this->getStackInstance()->pushNamed('node_announcement_answer', self::ANNOUNCEMENT_DATA_INTERNAL_ADDRESS); } /** - * Starts the node-udp-port + * Starts the my-session-id * * @return void */ - private function startNodeUdpPort () { + protected function startMySessionId () { // Push the node name on the stacker - $this->getStackerInstance()->pushNamed('announcement_answer', 'node-udp-port'); + $this->getStackInstance()->pushNamed('node_announcement_answer', self::ANNOUNCEMENT_DATA_SESSION_ID); } /** - * Starts the node-session-id + * Starts the my-status * * @return void */ - private function startNodeSessionId () { + protected function startMyStatus () { // Push the node name on the stacker - $this->getStackerInstance()->pushNamed('announcement_answer', 'node-session-id'); - } - - /** - * Starts the node-status - * - * @return void - */ - private function startNodeStatus () { - // Push the node name on the stacker - $this->getStackerInstance()->pushNamed('announcement_answer', 'node-status'); - } - - /** - * Finishes the node-status - * - * @return void - */ - private function finishNodeStatus () { - // Pop the last entry - $this->getStackerInstance()->popNamed('announcement_answer'); + $this->getStackInstance()->pushNamed('node_announcement_answer', self::ANNOUNCEMENT_DATA_NODE_STATUS); } /** - * Finishes the node-session-id + * Finishes the my-status * * @return void */ - private function finishNodeSessionId () { + protected function finishMyStatus () { // Pop the last entry - $this->getStackerInstance()->popNamed('announcement_answer'); + $this->getStackInstance()->popNamed('node_announcement_answer'); } /** - * Finishes the node-udp-port + * Finishes the my-session-id * * @return void */ - private function finishNodeUdpPort () { + protected function finishMySessionId () { // Pop the last entry - $this->getStackerInstance()->popNamed('announcement_answer'); + $this->getStackInstance()->popNamed('node_announcement_answer'); } /** - * Finishes the node-tcp-port + * Finishes the my-internal-address * * @return void */ - private function finishNodeTcpPort () { + protected function finishMyInternalAddress () { // Pop the last entry - $this->getStackerInstance()->popNamed('announcement_answer'); + $this->getStackInstance()->popNamed('node_announcement_answer'); } /** - * Finishes the node-internal-ip + * Finishes the my-external-address * * @return void */ - private function finishNodeInternalIp () { + protected function finishMyExternalAddress () { // Pop the last entry - $this->getStackerInstance()->popNamed('announcement_answer'); + $this->getStackInstance()->popNamed('node_announcement_answer'); } /** - * Finishes the node-external-ip + * Finishes the my-data * * @return void */ - private function finishNodeExternalIp () { + protected function finishMyData () { // Pop the last entry - $this->getStackerInstance()->popNamed('announcement_answer'); + $this->getStackInstance()->popNamed('node_announcement_answer'); } /** - * Finishes the node-data + * Starts the your-data * * @return void */ - private function finishNodeData () { - // Pop the last entry - $this->getStackerInstance()->popNamed('announcement_answer'); - } - - /** - * Starts the other-data - * - * @return void - */ - private function startOtherData () { + protected function startYourData () { // Push the node name on the stacker - $this->getStackerInstance()->pushNamed('announcement_answer', 'other-data'); + $this->getStackInstance()->pushNamed('node_announcement_answer', 'your-data'); } /** - * Starts the other-external-ip + * Starts the your-external-address * * @return void */ - private function startOtherExternalIp () { + protected function startYourExternalAddress () { // Push the node name on the stacker - $this->getStackerInstance()->pushNamed('announcement_answer', 'other-external-ip'); + $this->getStackInstance()->pushNamed('node_announcement_answer', 'your-external-address'); } /** - * Starts the other-internal-ip + * Starts the your-internal-address * * @return void */ - private function startOtherInternalIp () { + protected function startYourInternalAddress () { // Push the node name on the stacker - $this->getStackerInstance()->pushNamed('announcement_answer', 'other-internal-ip'); + $this->getStackInstance()->pushNamed('node_announcement_answer', 'your-internal-address'); } /** - * Starts the other-session-id + * Starts the your-session-id * * @return void */ - private function startOtherSessionId () { + protected function startYourSessionId () { // Push the node name on the stacker - $this->getStackerInstance()->pushNamed('announcement_answer', 'other-session-id'); - } - - /** - * Finishes the other-session-id - * - * @return void - */ - private function finishOtherSessionId () { - // Pop the last entry - $this->getStackerInstance()->popNamed('announcement_answer'); + $this->getStackInstance()->pushNamed('node_announcement_answer', 'your-session-id'); } /** - * Finishes the other-internal-ip + * Finishes the your-session-id * * @return void */ - private function finishOtherInternalIp () { + protected function finishYourSessionId () { // Pop the last entry - $this->getStackerInstance()->popNamed('announcement_answer'); + $this->getStackInstance()->popNamed('node_announcement_answer'); } /** - * Finishes the other-external-ip + * Finishes the your-internal-address * * @return void */ - private function finishOtherExternalIp () { + protected function finishYourInternalAddress () { // Pop the last entry - $this->getStackerInstance()->popNamed('announcement_answer'); + $this->getStackInstance()->popNamed('node_announcement_answer'); } /** - * Finishes the other-data + * Finishes the your-external-address * * @return void */ - private function finishOtherData () { + protected function finishYourExternalAddress () { // 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', 'answer-status'); + $this->getStackInstance()->popNamed('node_announcement_answer'); } /** - * Finishes the answer-status + * Finishes the your-data * * @return void */ - private function finishAnswerStatus () { + protected function finishYourData () { // Pop the last entry - $this->getStackerInstance()->popNamed('announcement_answer'); + $this->getStackInstance()->popNamed('node_announcement_answer'); } /** @@ -527,9 +310,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'); } }