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 {
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 * @param $applicationInstance A manageable application
73 * @return $templateInstance An instance of TemplateEngine
74 * @throws BasePathIsEmptyException If the provided $templateBasePath is empty
75 * @throws InvalidBasePathStringException If $templateBasePath is no string
76 * @throws BasePathIsNoDirectoryException If $templateBasePath is no
77 * directory or not found
78 * @throws BasePathReadProtectedException If $templateBasePath is
81 public static final function createXmlAnnouncementTemplateEngine (ManageableApplication $applicationInstance) {
83 $templateInstance = new XmlAnnouncementTemplateEngine();
85 // Determine base path
86 $templateBasePath = $templateInstance->getConfigInstance()->getConfigEntry('application_base_path') . $applicationInstance->getRequestInstance()->getRequestElement('app') . '/';
88 // Is the base path valid?
89 if (empty($templateBasePath)) {
91 throw new BasePathIsEmptyException($templateInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
92 } elseif (!is_string($templateBasePath)) {
94 throw new InvalidBasePathStringException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_STRING);
95 } elseif (!is_dir($templateBasePath)) {
97 throw new BasePathIsNoDirectoryException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_PATH_NAME);
98 } elseif (!is_readable($templateBasePath)) {
100 throw new BasePathReadProtectedException(array($templateInstance, $templateBasePath), self::EXCEPTION_READ_PROTECED_PATH);
104 $templateInstance->setTemplateBasePath($templateBasePath);
106 // Set template extensions
107 $templateInstance->setRawTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('raw_template_extension'));
108 $templateInstance->setCodeTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('announcement_template_extension'));
110 // Absolute output path for compiled templates
111 $templateInstance->setCompileOutputPath($templateInstance->getConfigInstance()->getConfigEntry('base_path') . $templateInstance->getConfigInstance()->getConfigEntry('compile_output_path'));
113 // Init a variable stacker
114 $stackerInstance = ObjectFactory::createObjectByConfiguredName('announcement_stacker_class');
117 $templateInstance->setStackerInstance($stackerInstance);
119 // Return the prepared instance
120 return $templateInstance;
124 * Load a specified announcement template into the engine
126 * @param $template The announcement template we shall load which is
127 * located in 'announcement' by default
130 public function loadAnnouncementTemplate ($template = 'self_announcement') {
132 $this->setTemplateType($this->getConfigInstance()->getConfigEntry('announcement_template_type'));
134 // Load the special template
135 $this->loadTemplate($template);
139 * Getter for current main node
141 * @return $currMainNode Current main node
143 public final function getCurrMainNode () {
144 return $this->curr['main_node'];
148 * Setter for current main node
150 * @param $element Element name to set as current main node
151 * @return $currMainNode Current main node
153 private final function setCurrMainNode ($element) {
154 $this->curr['main_node'] = (string) $element;
158 * Getter for main node array
160 * @return $mainNodes Array with valid main node names
162 public final function getMainNodes () {
163 return $this->mainNodes;
167 * Getter for sub node array
169 * @return $subNodes Array with valid sub node names
171 public final function getSubNodes () {
172 return $this->subNodes;
176 * Handles the start element of an XML resource
178 * @param $resource XML parser resource (currently ignored)
179 * @param $element The element we shall handle
180 * @param $attributes All attributes
182 * @throws InvalidXmlNodeException If an unknown/invalid XML node name was found
184 public function startElement ($resource, $element, array $attributes) {
185 // Initial method name which will never be called...
186 $methodName = 'initAnnouncement';
188 // Make the element name lower-case
189 $element = strtolower($element);
191 // Is the element a main node?
192 //* DEBUG: */ echo "START: >".$element."<<br />\n";
193 if (in_array($element, $this->getMainNodes())) {
194 // Okay, main node found!
195 $methodName = 'start' . $this->convertToClassName($element);
198 $this->setCurrMainNode($element);
199 } elseif (in_array($element, $this->getSubNodes())) {
201 $methodName = 'start' . $this->convertToClassName($element);
203 // Invalid node name found
204 throw new InvalidXmlNodeException(array($this, $element, $attributes), XmlParser::EXCEPTION_XML_NODE_UNKNOWN);
208 //* DEBUG: */ echo "call: ".$methodName."<br />\n";
209 call_user_func_array(array($this, $methodName), $attributes);
213 * Ends the main or sub node by sending out the gathered data
215 * @param $resource An XML resource pointer (currently ignored)
216 * @param $nodeName Name of the node we want to finish
218 * @throws XmlNodeMismatchException If current main node mismatches the closing one
220 public function endElement ($resource, $nodeName) {
221 // Make all lower-case
222 $nodeName = strtolower($nodeName);
224 // Does this match with current main node?
225 //* DEBUG: */ echo "END: >".$nodeName."<<br />\n";
226 if (($nodeName != $this->getCurrMainNode()) && (in_array($nodeName, $this->getMainNodes()))) {
228 throw new XmlNodeMismatchException (array($this, $nodeName, $this->getCurrMainNode()), XmlParser::EXCEPTION_XML_NODE_MISMATCH);
231 // Construct method name
232 $methodName = 'finish' . $this->convertToClassName($nodeName);
234 // Call the corresponding method
235 //* DEBUG: */ echo "call: ".$methodName."<br />\n";
236 call_user_func_array(array($this, $methodName), array());
242 * @param $resource XML parser resource (currently ignored)
243 * @param $characters Characters to handle
245 * @todo Find something useful with this!
247 public function characterHandler ($resource, $characters) {
248 // Trim all spaces away
249 $characters = trim($characters);
251 // Is this string empty?
252 if (empty($characters)) {
253 // Then skip it silently
257 // Assign the found characters to variable and use the last entry from
259 parent::assignVariable($this->getStackerInstance()->getNamed('announcement'), $characters);
263 * Handles the template dependency for given node
265 * @param $node The node we should load a dependency template
266 * @param $templateDependency A template to load to satisfy dependencies
269 private function handleTemplateDependency ($node, $templateDependency) {
270 // Is the template dependency set?
271 if ((!empty($templateDependency)) && (!isset($this->dependencyContent[$node]))) {
272 // Get a temporay template instance
273 $templateInstance = ObjectFactory::createObjectByConfiguredName('announcement_template_class', array($this->getApplicationInstance()));
276 $templateInstance->loadAnnouncementTemplate($templateDependency);
278 // Parse the XML content
279 $templateInstance->renderXmlContent();
281 // Save the parsed raw content in our dependency array
282 $this->dependencyContent[$node] = $templateInstance->getRawTemplateData();
287 * Getter for cache file (FQFN)
289 * @return $fqfn Full-qualified file name of the menu cache
291 public function getMenuCacheFqfn () {
292 $this->partialStub('Please implement this method.');
296 * Starts the announcement
300 private function startAnnouncement () {
301 // Push the node name on the stacker
302 $this->getStackerInstance()->pushNamed('announcement', 'announcement');
306 * Starts the announcement data
310 private function startAnnouncementData () {
311 // Push the node name on the stacker
312 $this->getStackerInstance()->pushNamed('announcement', 'announcement-data');
320 private function startNodeId () {
321 // Push the node name on the stacker
322 $this->getStackerInstance()->pushNamed('announcement', 'node-id');
326 * Starts the node status
330 private function startNodeStatus () {
331 // Push the node name on the stacker
332 $this->getStackerInstance()->pushNamed('announcement', 'node-status');
336 * Starts the listener
340 private function startListener () {
341 // Push the node name on the stacker
342 $this->getStackerInstance()->pushNamed('announcement', 'listener');
346 * Starts the client listener
350 private function startClientListener () {
351 // Push the node name on the stacker
352 $this->getStackerInstance()->pushNamed('announcement', 'client-listener');
356 * Starts the hub listener
360 private function startHubListener () {
361 // Push the node name on the stacker
362 $this->getStackerInstance()->pushNamed('announcement', 'hub-listener');
366 * Starts the TCP port
370 private function startTcpPort () {
371 // Push the node name on the stacker
372 $this->getStackerInstance()->pushNamed('announcement', 'tcp-port');
376 * Starts the UDP port
380 private function startUdpPort () {
381 // Push the node name on the stacker
382 $this->getStackerInstance()->pushNamed('announcement', 'udp-port');
386 * Starts the session id
390 private function startSessionId () {
391 // Push the node name on the stacker
392 $this->getStackerInstance()->pushNamed('announcement', 'session-id');
396 * Starts the object type list
400 private function startObjectTypeList () {
401 // Push the node name on the stacker
402 $this->getStackerInstance()->pushNamed('announcement', 'object-type-list');
406 * Starts the object type
410 private function startObjectType () {
411 // Push the node name on the stacker
412 $this->getStackerInstance()->pushNamed('announcement', 'object-type');
416 * Finishes the object type
420 private function finishObjectType () {
421 // Pop the last entry
422 $this->getStackerInstance()->popNamed('announcement');
426 * Finishes the object type list
430 private function finishObjectTypeList () {
431 // Pop the last entry
432 $this->getStackerInstance()->popNamed('announcement');
436 * Finishes the session id
440 private function finishSessionId () {
441 // Pop the last entry
442 $this->getStackerInstance()->popNamed('announcement');
446 * Finishes the UDP port
450 private function finishUdpPort () {
451 // Pop the last entry
452 $this->getStackerInstance()->popNamed('announcement');
456 * Finishes the TCP port
460 private function finishTcpPort () {
461 // Pop the last entry
462 $this->getStackerInstance()->popNamed('announcement');
466 * Finishes the hub listener
470 private function finishHubListener () {
471 // Pop the last entry
472 $this->getStackerInstance()->popNamed('announcement');
476 * Finishes the client listener
480 private function finishClientListener () {
481 // Pop the last entry
482 $this->getStackerInstance()->popNamed('announcement');
486 * Finishes the listener
490 private function finishListener () {
491 // Pop the last entry
492 $this->getStackerInstance()->popNamed('announcement');
496 * Finishes the node status
500 private function finishNodeStatus () {
501 // Pop the last entry
502 $this->getStackerInstance()->popNamed('announcement');
506 * Finishes the node id
510 private function finishNodeId () {
511 // Pop the last entry
512 $this->getStackerInstance()->popNamed('announcement');
516 * Finishes the announcement data
520 private function finishAnnouncementData () {
521 // Pop the last entry
522 $this->getStackerInstance()->popNamed('announcement');
526 * Finishes the announcement
530 private function finishAnnouncement () {
531 // Pop the last entry
532 $this->getStackerInstance()->popNamed('announcement');