/**
* An Announcement 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 - 2011 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 XmlAnnouncementTemplateEngine extends BaseTemplateEngine implements CompileableTemplate, Registerable {
+class XmlAnnouncementTemplateEngine extends BaseXmlTemplateEngine implements CompileableTemplate, Registerable {
/**
- * Main nodes in the XML tree
+ * Some XML nodes must be available for later data extraction
*/
- private $mainNodes = array(
- 'announcement',
- );
-
- /**
- * Sub nodes in the XML tree
- */
- private $subNodes = array(
- 'announcement-data',
- 'listener',
- 'hub-listener',
- 'client-listener',
- 'node-id',
- 'node-status',
- 'tcp-port',
- 'udp-port',
- 'session-id',
- 'object-type-list',
- );
-
- /**
- * Current main node
- */
- private $curr = array();
-
- /**
- * Content from dependency
- */
- private $dependencyContent = array();
+ const ANNOUNCEMENT_DATA_SESSION_ID = 'session-id';
+ const ANNOUNCEMENT_DATA_NODE_STATUS = 'node-status';
+ const ANNOUNCEMENT_DATA_NODE_MODE = 'node-mode';
+ const ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS = 'external-address';
+ const ANNOUNCEMENT_DATA_INTERNAL_ADDRESS = 'internal-address';
/**
* Protected constructor
protected function __construct () {
// Call parent constructor
parent::__construct(__CLASS__);
+
+ // Init array
+ $this->setSubNodes(array(
+ 'announcement-data',
+ 'listener',
+ self::ANNOUNCEMENT_DATA_NODE_STATUS,
+ self::ANNOUNCEMENT_DATA_NODE_MODE,
+ self::ANNOUNCEMENT_DATA_SESSION_ID,
+ self::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS,
+ self::ANNOUNCEMENT_DATA_INTERNAL_ADDRESS,
+ 'object-type-list',
+ ));
}
/**
// Get a new instance
$templateInstance = new XmlAnnouncementTemplateEngine();
- // Get the 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_announcement_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_stacker_class');
-
- // Set it
- $templateInstance->setStackerInstance($stackerInstance);
+ // Init template instance
+ $templateInstance->initXmlTemplateEngine('node', 'announcement');
// Return the prepared instance
return $templateInstance;
}
- /**
- * Load a specified announcement template into the engine
- *
- * @param $template The announcement template we shall load which is
- * located in 'announcement' by default
- * @return void
- */
- public function loadAnnouncementTemplate ($template = 'self_announcement') {
- // Set template type
- $this->setTemplateType($this->getConfigInstance()->getConfigEntry('node_announcement_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 = 'initAnnouncement';
-
- // 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
- //* DEBUG: */ echo "call: ".$methodName."<br />\n";
- 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'), $characters);
- }
-
- /**
- * Handles the template dependency for given node
- *
- * @param $node The node we should load a dependency template
- * @param $templateDependency A template to load to satisfy dependencies
- * @return void
- */
- private function handleTemplateDependency ($node, $templateDependency) {
- // Is the template dependency set?
- if ((!empty($templateDependency)) && (!isset($this->dependencyContent[$node]))) {
- // Get a temporay template instance
- $templateInstance = XmlTemplateEngineFactory::createXmlTemplateEngineInstance('node_announcement_template_class');
-
- // Then load it
- $templateInstance->loadAnnouncementTemplate($templateDependency);
-
- // Parse the XML content
- $templateInstance->renderXmlContent();
-
- // Save the parsed raw content in our dependency array
- $this->dependencyContent[$node] = $templateInstance->getRawTemplateData();
- } // END - if
+ /*
+ * Assign the found characters to variable and use the last entry from
+ * stack as the name.
+ */
+ parent::assignVariable($this->getStackInstance()->getNamed('node_announcement'), $characters);
}
/**
*
* @return void
*/
- private function startAnnouncement () {
+ protected function startAnnouncement () {
// Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('announcement', 'announcement');
+ $this->getStackInstance()->pushNamed('node_announcement', 'announcement');
}
/**
*
* @return void
*/
- private function startAnnouncementData () {
- // Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('announcement', 'announcement-data');
- }
-
- /**
- * Starts the node id
- *
- * @return void
- */
- private function startNodeId () {
+ protected function startAnnouncementData () {
// Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('announcement', 'node-id');
+ $this->getStackInstance()->pushNamed('node_announcement', 'announcement-data');
}
/**
*
* @return void
*/
- private function startNodeStatus () {
+ protected function startNodeStatus () {
// Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('announcement', 'node-status');
+ $this->getStackInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_NODE_STATUS);
}
/**
- * Starts the listener
- *
- * @return void
- */
- private function startListener () {
- // Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('announcement', 'listener');
- }
-
- /**
- * Starts the client listener
+ * Starts the node-mode
*
* @return void
*/
- private function startClientListener () {
+ protected function startNodeMode () {
// Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('announcement', 'client-listener');
+ $this->getStackInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_NODE_MODE);
}
/**
- * Starts the hub listener
+ * Starts the listener
*
* @return void
*/
- private function startHubListener () {
+ protected function startListener () {
// Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('announcement', 'hub-listener');
+ $this->getStackInstance()->pushNamed('node_announcement', 'listener');
}
/**
- * Starts the TCP port
+ * Starts the session id
*
* @return void
*/
- private function startTcpPort () {
+ protected function startSessionId () {
// Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('announcement', 'tcp-port');
+ $this->getStackInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_SESSION_ID);
}
/**
- * Starts the UDP port
+ * Starts the public ip
*
* @return void
*/
- private function startUdpPort () {
+ protected function startExternalAddress () {
// Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('announcement', 'udp-port');
+ $this->getStackInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_EXTERNAL_ADDRESS);
}
/**
- * Starts the session id
+ * Starts the private ip
*
* @return void
*/
- private function startSessionId () {
+ protected function startInternalAddress () {
// Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('announcement', 'session-id');
+ $this->getStackInstance()->pushNamed('node_announcement', self::ANNOUNCEMENT_DATA_INTERNAL_ADDRESS);
}
/**
*
* @return void
*/
- private function startObjectTypeList () {
+ protected function startObjectTypeList () {
// Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('announcement', 'object-type-list');
+ $this->getStackInstance()->pushNamed('node_announcement', 'object-type-list');
}
/**
*
* @return void
*/
- private function startObjectType () {
+ protected function startObjectType () {
// Push the node name on the stacker
- $this->getStackerInstance()->pushNamed('announcement', 'object-type');
+ $this->getStackInstance()->pushNamed('node_announcement', 'object-type');
}
/**
*
* @return void
*/
- private function finishObjectType () {
+ protected function finishObjectType () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('announcement');
+ $this->getStackInstance()->popNamed('node_announcement');
}
/**
*
* @return void
*/
- private function finishObjectTypeList () {
+ protected function finishObjectTypeList () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('announcement');
+ $this->getStackInstance()->popNamed('node_announcement');
}
/**
*
* @return void
*/
- private function finishSessionId () {
+ protected function finishSessionId () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('announcement');
+ $this->getStackInstance()->popNamed('node_announcement');
}
/**
- * Finishes the UDP port
+ * Finishes the private ip
*
* @return void
*/
- private function finishUdpPort () {
+ protected function finishInternalAddress () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('announcement');
+ $this->getStackInstance()->popNamed('node_announcement');
}
/**
- * Finishes the TCP port
+ * Finishes the public ip
*
* @return void
*/
- private function finishTcpPort () {
+ protected function finishExternalAddress () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('announcement');
- }
-
- /**
- * Finishes the hub listener
- *
- * @return void
- */
- private function finishHubListener () {
- // Pop the last entry
- $this->getStackerInstance()->popNamed('announcement');
- }
-
- /**
- * Finishes the client listener
- *
- * @return void
- */
- private function finishClientListener () {
- // Pop the last entry
- $this->getStackerInstance()->popNamed('announcement');
+ $this->getStackInstance()->popNamed('node_announcement');
}
/**
*
* @return void
*/
- private function finishListener () {
+ protected function finishListener () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('announcement');
+ $this->getStackInstance()->popNamed('node_announcement');
}
/**
- * Finishes the node status
+ * Finishes the node mode
*
* @return void
*/
- private function finishNodeStatus () {
+ protected function finishNodeMode () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('announcement');
+ $this->getStackInstance()->popNamed('node_announcement');
}
/**
- * Finishes the node id
+ * Finishes the node status
*
* @return void
*/
- private function finishNodeId () {
+ protected function finishNodeStatus () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('announcement');
+ $this->getStackInstance()->popNamed('node_announcement');
}
/**
*
* @return void
*/
- private function finishAnnouncementData () {
+ protected function finishAnnouncementData () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('announcement');
+ $this->getStackInstance()->popNamed('node_announcement');
}
/**
*
* @return void
*/
- private function finishAnnouncement () {
+ protected function finishAnnouncement () {
// Pop the last entry
- $this->getStackerInstance()->popNamed('announcement');
+ $this->getStackInstance()->popNamed('node_announcement');
}
}
projects / hub.git / blobdiff