<?php
/**
- * An ??? template engine class for XML templates
+ * An AnnouncementAnswer template engine class for XML templates
*
- * @author Roland Haeder <webmaster@ship-simu.org>
+ * @author Roland Haeder <webmaster@shipsimu.org>
* @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
* 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 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
- 'my-data',
- 'your-data',
- // Data from *this* node
- 'my-external-ip',
- 'my-internal-ip',
- 'my-tcp-port',
- 'my-udp-port',
- 'my-session-id',
- 'my-status',
- // Data from other node
- 'your-external-ip',
- 'your-internal-ip',
- 'your-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_IP = 'my-external-ip';
+ const ANNOUNCEMENT_DATA_INTERNAL_IP = 'my-internal-ip';
+ const ANNOUNCEMENT_DATA_LISTEN_PORT = 'my-listen-port';
/**
* Protected constructor
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_IP,
+ self::ANNOUNCEMENT_DATA_INTERNAL_IP,
+ 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 (generic field)
+ self::ANSWER_STATUS,
+ );
}
/**
// 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."<<br />\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."<<br />\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."<br />\n";
- call_user_func_array(array($this, $methodName), array());
- }
-
/**
* Currently not used
*
// 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);
}
/**
*
* @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');
}
/**
*
* @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');
}
/**
*
* @return void
*/
- private function startMyExternalIp () {
+ protected function startMyExternalIp () {
// Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('announcement_answer', 'my-external-ip');
+ $this->getStackInstance()->pushNamed('node_announcement_answer', self::ANNOUNCEMENT_DATA_EXTERNAL_IP);
}
/**
*
* @return void
*/
- private function startMyInternalIp () {
+ protected function startMyInternalIp () {
// Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('announcement_answer', 'my-internal-ip');
+ $this->getStackInstance()->pushNamed('node_announcement_answer', self::ANNOUNCEMENT_DATA_INTERNAL_IP);
}
/**
*
* @return void
*/
- private function startMyTcpPort () {
+ protected function startMyListenPort () {
// Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('announcement_answer', 'my-tcp-port');
- }
-
- /**
- * Starts the my-udp-port
- *
- * @return void
- */
- private function startMyUdpPort () {
- // Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('announcement_answer', 'my-udp-port');
+ $this->getStackInstance()->pushNamed('node_announcement_answer', self::ANNOUNCEMENT_DATA_LISTEN_PORT);
}
/**
*
* @return void
*/
- private function startMySessionId () {
+ protected function startMySessionId () {
// Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('announcement_answer', 'my-session-id');
+ $this->getStackInstance()->pushNamed('node_announcement_answer', self::ANNOUNCEMENT_DATA_SESSION_ID);
}
/**
*
* @return void
*/
- private function startMyStatus () {
+ protected function startMyStatus () {
// Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('announcement_answer', 'my-status');
+ $this->getStackInstance()->pushNamed('node_announcement_answer', self::ANNOUNCEMENT_DATA_NODE_STATUS);
}
/**
*
* @return void
*/
- private function finishMyStatus () {
+ protected function finishMyStatus () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('announcement_answer');
+ $this->getStackInstance()->popNamed('node_announcement_answer');
}
/**
*
* @return void
*/
- private function finishMySessionId () {
+ protected function finishMySessionId () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('announcement_answer');
- }
-
- /**
- * Finishes the my-udp-port
- *
- * @return void
- */
- private function finishMyUdpPort () {
- // Pop the last entry
- $this->getStackerInstance()->popNamed('announcement_answer');
+ $this->getStackInstance()->popNamed('node_announcement_answer');
}
/**
*
* @return void
*/
- private function finishMyTcpPort () {
+ protected function finishMyListenPort () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('announcement_answer');
+ $this->getStackInstance()->popNamed('node_announcement_answer');
}
/**
*
* @return void
*/
- private function finishMyInternalIp () {
+ protected function finishMyInternalIp () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('announcement_answer');
+ $this->getStackInstance()->popNamed('node_announcement_answer');
}
/**
*
* @return void
*/
- private function finishMyExternalIp () {
+ protected function finishMyExternalIp () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('announcement_answer');
+ $this->getStackInstance()->popNamed('node_announcement_answer');
}
/**
*
* @return void
*/
- private function finishMyData () {
+ protected function finishMyData () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('announcement_answer');
+ $this->getStackInstance()->popNamed('node_announcement_answer');
}
/**
*
* @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');
}
/**
*
* @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');
}
/**
*
* @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');
}
/**
*
* @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');
}
/**
*
* @return void
*/
- private function finishYourSessionId () {
+ protected function finishYourSessionId () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('announcement_answer');
+ $this->getStackInstance()->popNamed('node_announcement_answer');
}
/**
*
* @return void
*/
- private function finishYourInternalIp () {
+ protected function finishYourInternalIp () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('announcement_answer');
+ $this->getStackInstance()->popNamed('node_announcement_answer');
}
/**
*
* @return void
*/
- private function finishYourExternalIp () {
+ protected function finishYourExternalIp () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('announcement_answer');
+ $this->getStackInstance()->popNamed('node_announcement_answer');
}
/**
*
* @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', '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');
}
/**
*
* @return void
*/
- private function finishAnnouncementAnswer () {
+ protected function finishAnnouncementAnswer () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('announcement_answer');
+ $this->getStackInstance()->popNamed('node_announcement_answer');
}
}
projects / hub.git / blobdiff