3 * An Announcement template engine class for XML templates
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
10 * @todo This template engine does not make use of setTemplateType()
12 * This program is free software: you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation, either version 3 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 class XmlAnnouncementTemplateEngine extends BaseTemplateEngine implements CompileableTemplate, Registerable {
27 * Main nodes in the XML tree
29 private $mainNodes = array(
34 * Sub nodes in the XML tree
36 private $subNodes = array(
52 private $curr = array();
55 * Content from dependency
57 private $dependencyContent = array();
60 * Protected constructor
64 protected function __construct () {
65 // Call parent constructor
66 parent::__construct(__CLASS__);
70 * Creates an instance of the class TemplateEngine and prepares it for usage
72 * @return $templateInstance An instance of TemplateEngine
73 * @throws BasePathIsEmptyException If the provided $templateBasePath is empty
74 * @throws InvalidBasePathStringException If $templateBasePath is no string
75 * @throws BasePathIsNoDirectoryException If $templateBasePath is no
76 * directory or not found
77 * @throws BasePathReadProtectedException If $templateBasePath is
80 public static final function createXmlAnnouncementTemplateEngine () {
82 $templateInstance = new XmlAnnouncementTemplateEngine();
84 // Get the application instance from registry
85 $applicationInstance = Registry::getRegistry()->getInstance('app');
87 // Determine base path
88 $templateBasePath = $templateInstance->getConfigInstance()->getConfigEntry('application_base_path') . $applicationInstance->getRequestInstance()->getRequestElement('app') . '/';
90 // Is the base path valid?
91 if (empty($templateBasePath)) {
93 throw new BasePathIsEmptyException($templateInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
94 } elseif (!is_string($templateBasePath)) {
96 throw new InvalidBasePathStringException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_STRING);
97 } elseif (!is_dir($templateBasePath)) {
99 throw new BasePathIsNoDirectoryException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_PATH_NAME);
100 } elseif (!is_readable($templateBasePath)) {
102 throw new BasePathReadProtectedException(array($templateInstance, $templateBasePath), self::EXCEPTION_READ_PROTECED_PATH);
106 $templateInstance->setTemplateBasePath($templateBasePath);
108 // Set template extensions
109 $templateInstance->setRawTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('raw_template_extension'));
110 $templateInstance->setCodeTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('node_announcement_template_extension'));
112 // Absolute output path for compiled templates
113 $templateInstance->setCompileOutputPath($templateInstance->getConfigInstance()->getConfigEntry('base_path') . $templateInstance->getConfigInstance()->getConfigEntry('compile_output_path'));
115 // Init a variable stacker
116 $stackerInstance = ObjectFactory::createObjectByConfiguredName('node_announcement_stacker_class');
119 $templateInstance->setStackerInstance($stackerInstance);
121 // Return the prepared instance
122 return $templateInstance;
126 * Load a specified announcement template into the engine
128 * @param $template The announcement template we shall load which is
129 * located in 'announcement' by default
132 public function loadAnnouncementTemplate ($template = 'self_announcement') {
134 $this->setTemplateType($this->getConfigInstance()->getConfigEntry('node_announcement_template_type'));
136 // Load the special template
137 $this->loadTemplate($template);
141 * Getter for current main node
143 * @return $currMainNode Current main node
145 public final function getCurrMainNode () {
146 return $this->curr['main_node'];
150 * Setter for current main node
152 * @param $element Element name to set as current main node
153 * @return $currMainNode Current main node
155 private final function setCurrMainNode ($element) {
156 $this->curr['main_node'] = (string) $element;
160 * Getter for main node array
162 * @return $mainNodes Array with valid main node names
164 public final function getMainNodes () {
165 return $this->mainNodes;
169 * Getter for sub node array
171 * @return $subNodes Array with valid sub node names
173 public final function getSubNodes () {
174 return $this->subNodes;
178 * Handles the start element of an XML resource
180 * @param $resource XML parser resource (currently ignored)
181 * @param $element The element we shall handle
182 * @param $attributes All attributes
184 * @throws InvalidXmlNodeException If an unknown/invalid XML node name was found
186 public function startElement ($resource, $element, array $attributes) {
187 // Initial method name which will never be called...
188 $methodName = 'initAnnouncement';
190 // Make the element name lower-case
191 $element = strtolower($element);
193 // Is the element a main node?
194 //* DEBUG: */ echo "START: >".$element."<<br />\n";
195 if (in_array($element, $this->getMainNodes())) {
196 // Okay, main node found!
197 $methodName = 'start' . $this->convertToClassName($element);
200 $this->setCurrMainNode($element);
201 } elseif (in_array($element, $this->getSubNodes())) {
203 $methodName = 'start' . $this->convertToClassName($element);
205 // Invalid node name found
206 throw new InvalidXmlNodeException(array($this, $element, $attributes), XmlParser::EXCEPTION_XML_NODE_UNKNOWN);
210 //* DEBUG: */ echo "call: ".$methodName."<br />\n";
211 call_user_func_array(array($this, $methodName), $attributes);
215 * Ends the main or sub node by sending out the gathered data
217 * @param $resource An XML resource pointer (currently ignored)
218 * @param $nodeName Name of the node we want to finish
220 * @throws XmlNodeMismatchException If current main node mismatches the closing one
222 public function endElement ($resource, $nodeName) {
223 // Make all lower-case
224 $nodeName = strtolower($nodeName);
226 // Does this match with current main node?
227 //* DEBUG: */ echo "END: >".$nodeName."<<br />\n";
228 if (($nodeName != $this->getCurrMainNode()) && (in_array($nodeName, $this->getMainNodes()))) {
230 throw new XmlNodeMismatchException (array($this, $nodeName, $this->getCurrMainNode()), XmlParser::EXCEPTION_XML_NODE_MISMATCH);
233 // Construct method name
234 $methodName = 'finish' . $this->convertToClassName($nodeName);
236 // Call the corresponding method
237 //* DEBUG: */ echo "call: ".$methodName."<br />\n";
238 call_user_func_array(array($this, $methodName), array());
244 * @param $resource XML parser resource (currently ignored)
245 * @param $characters Characters to handle
248 public function characterHandler ($resource, $characters) {
249 // Trim all spaces away
250 $characters = trim($characters);
252 // Is this string empty?
253 if (empty($characters)) {
254 // Then skip it silently
258 // Assign the found characters to variable and use the last entry from
260 parent::assignVariable($this->getStackerInstance()->getNamed('announcement'), $characters);
264 * Handles the template dependency for given node
266 * @param $node The node we should load a dependency template
267 * @param $templateDependency A template to load to satisfy dependencies
270 private function handleTemplateDependency ($node, $templateDependency) {
271 // Is the template dependency set?
272 if ((!empty($templateDependency)) && (!isset($this->dependencyContent[$node]))) {
273 // Get a temporay template instance
274 $templateInstance = XmlTemplateEngineFactory::createXmlTemplateEngineInstance('node_announcement_template_class');
277 $templateInstance->loadAnnouncementTemplate($templateDependency);
279 // Parse the XML content
280 $templateInstance->renderXmlContent();
282 // Save the parsed raw content in our dependency array
283 $this->dependencyContent[$node] = $templateInstance->getRawTemplateData();
288 * Getter for cache file (FQFN)
290 * @return $fqfn Full-qualified file name of the menu cache
292 public function getMenuCacheFqfn () {
293 $this->partialStub('Please implement this method.');
297 * Starts the announcement
301 private function startAnnouncement () {
302 // Push the node name on the stacker
303 $this->getStackerInstance()->pushNamed('announcement', 'announcement');
307 * Starts the announcement data
311 private function startAnnouncementData () {
312 // Push the node name on the stacker
313 $this->getStackerInstance()->pushNamed('announcement', 'announcement-data');
317 * Starts the node status
321 private function startNodeStatus () {
322 // Push the node name on the stacker
323 $this->getStackerInstance()->pushNamed('announcement', 'node-status');
327 * Starts the listener
331 private function startListener () {
332 // Push the node name on the stacker
333 $this->getStackerInstance()->pushNamed('announcement', 'listener');
337 * Starts the client listener
341 private function startClientListener () {
342 // Push the node name on the stacker
343 $this->getStackerInstance()->pushNamed('announcement', 'client-listener');
347 * Starts the hub listener
351 private function startHubListener () {
352 // Push the node name on the stacker
353 $this->getStackerInstance()->pushNamed('announcement', 'hub-listener');
357 * Starts the TCP port
361 private function startTcpPort () {
362 // Push the node name on the stacker
363 $this->getStackerInstance()->pushNamed('announcement', 'tcp-port');
367 * Starts the UDP port
371 private function startUdpPort () {
372 // Push the node name on the stacker
373 $this->getStackerInstance()->pushNamed('announcement', 'udp-port');
377 * Starts the session id
381 private function startSessionId () {
382 // Push the node name on the stacker
383 $this->getStackerInstance()->pushNamed('announcement', 'session-id');
387 * Starts the public ip
391 private function startExternalIp () {
392 // Push the node name on the stacker
393 $this->getStackerInstance()->pushNamed('announcement', 'external-ip');
397 * Starts the object type list
401 private function startObjectTypeList () {
402 // Push the node name on the stacker
403 $this->getStackerInstance()->pushNamed('announcement', 'object-type-list');
407 * Starts the object type
411 private function startObjectType () {
412 // Push the node name on the stacker
413 $this->getStackerInstance()->pushNamed('announcement', 'object-type');
417 * Finishes the object type
421 private function finishObjectType () {
422 // Pop the last entry
423 $this->getStackerInstance()->popNamed('announcement');
427 * Finishes the object type list
431 private function finishObjectTypeList () {
432 // Pop the last entry
433 $this->getStackerInstance()->popNamed('announcement');
437 * Finishes the session id
441 private function finishSessionId () {
442 // Pop the last entry
443 $this->getStackerInstance()->popNamed('announcement');
447 * Finishes the public ip
451 private function finishExternalIp () {
452 // Pop the last entry
453 $this->getStackerInstance()->popNamed('announcement');
457 * Finishes the UDP port
461 private function finishUdpPort () {
462 // Pop the last entry
463 $this->getStackerInstance()->popNamed('announcement');
467 * Finishes the TCP port
471 private function finishTcpPort () {
472 // Pop the last entry
473 $this->getStackerInstance()->popNamed('announcement');
477 * Finishes the hub listener
481 private function finishHubListener () {
482 // Pop the last entry
483 $this->getStackerInstance()->popNamed('announcement');
487 * Finishes the client listener
491 private function finishClientListener () {
492 // Pop the last entry
493 $this->getStackerInstance()->popNamed('announcement');
497 * Finishes the listener
501 private function finishListener () {
502 // Pop the last entry
503 $this->getStackerInstance()->popNamed('announcement');
507 * Finishes the node status
511 private function finishNodeStatus () {
512 // Pop the last entry
513 $this->getStackerInstance()->popNamed('announcement');
517 * Finishes the announcement data
521 private function finishAnnouncementData () {
522 // Pop the last entry
523 $this->getStackerInstance()->popNamed('announcement');
527 * Finishes the announcement
531 private function finishAnnouncement () {
532 // Pop the last entry
533 $this->getStackerInstance()->popNamed('announcement');