application/hub/main/template/announcement/class_XmlAnnouncementTemplateEngine.php

   1 <?php
   2 /**
   3  * An Announcement template engine class for XML templates
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   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()
  11  *
  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.
  16  *
  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.
  21  *
  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/>.
  24  */
  25 class XmlAnnouncementTemplateEngine extends BaseTemplateEngine implements CompileableTemplate {
  26         /**
  27          * Main nodes in the XML tree
  28          */
  29         private $mainNodes = array(
  30                 'announcement',
  31         );
  32
  33         /**
  34          * Sub nodes in the XML tree
  35          */
  36         private $subNodes = array(
  37                 'announcement-data',
  38                 'listener',
  39                 'hub-listener',
  40                 'client-listener',
  41                 'node-id',
  42                 'node-status',
  43                 'tcp-port',
  44                 'udp-port',
  45                 'session-id',
  46                 'object-type-list',
  47         );
  48
  49         /**
  50          * Current main node
  51          */
  52         private $curr = array();
  53
  54         /**
  55          * Content from dependency
  56          */
  57         private $dependencyContent = array();
  58
  59         /**
  60          * Protected constructor
  61          *
  62          * @return      void
  63          */
  64         protected function __construct () {
  65                 // Call parent constructor
  66                 parent::__construct(__CLASS__);
  67         }
  68
  69         /**
  70          * Creates an instance of the class TemplateEngine and prepares it for usage
  71          *
  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
  78          *                                                                                      read-protected
  79          */
  80         public static final function createXmlAnnouncementTemplateEngine () {
  81                 // Get a new instance
  82                 $templateInstance = new XmlAnnouncementTemplateEngine();
  83
  84                 // Get the application instance from registry
  85                 $applicationInstance = Registry::getRegistry()->getInstance('app');
  86
  87                 // Determine base path
  88                 $templateBasePath = $templateInstance->getConfigInstance()->getConfigEntry('application_base_path') . $applicationInstance->getRequestInstance()->getRequestElement('app') . '/';
  89
  90                 // Is the base path valid?
  91                 if (empty($templateBasePath)) {
  92                         // Base path is empty
  93                         throw new BasePathIsEmptyException($templateInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
  94                 } elseif (!is_string($templateBasePath)) {
  95                         // Is not a string
  96                         throw new InvalidBasePathStringException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_STRING);
  97                 } elseif (!is_dir($templateBasePath)) {
  98                         // Is not a path
  99                         throw new BasePathIsNoDirectoryException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_PATH_NAME);
 100                 } elseif (!is_readable($templateBasePath)) {
 101                         // Is not readable
 102                         throw new BasePathReadProtectedException(array($templateInstance, $templateBasePath), self::EXCEPTION_READ_PROTECED_PATH);
 103                 }
 104
 105                 // Set the base path
 106                 $templateInstance->setTemplateBasePath($templateBasePath);
 107
 108                 // Set template extensions
 109                 $templateInstance->setRawTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('raw_template_extension'));
 110                 $templateInstance->setCodeTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('node_announcement_template_extension'));
 111
 112                 // Absolute output path for compiled templates
 113                 $templateInstance->setCompileOutputPath($templateInstance->getConfigInstance()->getConfigEntry('base_path') . $templateInstance->getConfigInstance()->getConfigEntry('compile_output_path'));
 114
 115                 // Init a variable stacker
 116                 $stackerInstance = ObjectFactory::createObjectByConfiguredName('node_announcement_stacker_class');
 117
 118                 // Set it
 119                 $templateInstance->setStackerInstance($stackerInstance);
 120
 121                 // Return the prepared instance
 122                 return $templateInstance;
 123         }
 124
 125         /**
 126          * Load a specified announcement template into the engine
 127          *
 128          * @param       $template       The announcement template we shall load which is
 129          *                                              located in 'announcement' by default
 130          * @return      void
 131          */
 132         public function loadAnnouncementTemplate ($template = 'self_announcement') {
 133                 // Set template type
 134                 $this->setTemplateType($this->getConfigInstance()->getConfigEntry('node_announcement_template_type'));
 135
 136                 // Load the special template
 137                 $this->loadTemplate($template);
 138         }
 139
 140         /**
 141          * Getter for current main node
 142          *
 143          * @return      $currMainNode   Current main node
 144          */
 145         public final function getCurrMainNode () {
 146                 return $this->curr['main_node'];
 147         }
 148
 149         /**
 150          * Setter for current main node
 151          *
 152          * @param       $element                Element name to set as current main node
 153          * @return      $currMainNode   Current main node
 154          */
 155         private final function setCurrMainNode ($element) {
 156                 $this->curr['main_node'] = (string) $element;
 157         }
 158
 159         /**
 160          * Getter for main node array
 161          *
 162          * @return      $mainNodes      Array with valid main node names
 163          */
 164         public final function getMainNodes () {
 165                 return $this->mainNodes;
 166         }
 167
 168         /**
 169          * Getter for sub node array
 170          *
 171          * @return      $subNodes       Array with valid sub node names
 172          */
 173         public final function getSubNodes () {
 174                 return $this->subNodes;
 175         }
 176
 177         /**
 178          * Handles the start element of an XML resource
 179          *
 180          * @param       $resource               XML parser resource (currently ignored)
 181          * @param       $element                The element we shall handle
 182          * @param       $attributes             All attributes
 183          * @return      void
 184          * @throws      InvalidXmlNodeException         If an unknown/invalid XML node name was found
 185          */
 186         public function startElement ($resource, $element, array $attributes) {
 187                 // Initial method name which will never be called...
 188                 $methodName = 'initAnnouncement';
 189
 190                 // Make the element name lower-case
 191                 $element = strtolower($element);
 192
 193                 // Is the element a main node?
 194                 //* DEBUG: */ echo "START: &gt;".$element."&lt;<br />\n";
 195                 if (in_array($element, $this->getMainNodes())) {
 196                         // Okay, main node found!
 197                         $methodName = 'start' . $this->convertToClassName($element);
 198
 199                         // Set it
 200                         $this->setCurrMainNode($element);
 201                 } elseif (in_array($element, $this->getSubNodes())) {
 202                         // Sub node found
 203                         $methodName = 'start' . $this->convertToClassName($element);
 204                 } else {
 205                         // Invalid node name found
 206                         throw new InvalidXmlNodeException(array($this, $element, $attributes), XmlParser::EXCEPTION_XML_NODE_UNKNOWN);
 207                 }
 208
 209                 // Call method
 210                 //* DEBUG: */ echo "call: ".$methodName."<br />\n";
 211                 call_user_func_array(array($this, $methodName), $attributes);
 212         }
 213
 214         /**
 215          * Ends the main or sub node by sending out the gathered data
 216          *
 217          * @param       $resource       An XML resource pointer (currently ignored)
 218          * @param       $nodeName       Name of the node we want to finish
 219          * @return      void
 220          * @throws      XmlNodeMismatchException        If current main node mismatches the closing one
 221          */
 222         public function endElement ($resource, $nodeName) {
 223                 // Make all lower-case
 224                 $nodeName = strtolower($nodeName);
 225
 226                 // Does this match with current main node?
 227                 //* DEBUG: */ echo "END: &gt;".$nodeName."&lt;<br />\n";
 228                 if (($nodeName != $this->getCurrMainNode()) && (in_array($nodeName, $this->getMainNodes()))) {
 229                         // Did not match!
 230                         throw new XmlNodeMismatchException (array($this, $nodeName, $this->getCurrMainNode()), XmlParser::EXCEPTION_XML_NODE_MISMATCH);
 231                 } // END - if
 232
 233                 // Construct method name
 234                 $methodName = 'finish' . $this->convertToClassName($nodeName);
 235
 236                 // Call the corresponding method
 237                 //* DEBUG: */ echo "call: ".$methodName."<br />\n";
 238                 call_user_func_array(array($this, $methodName), array());
 239         }
 240
 241         /**
 242          * Currently not used
 243          *
 244          * @param       $resource               XML parser resource (currently ignored)
 245          * @param       $characters             Characters to handle
 246          * @return      void
 247          * @todo        Find something useful with this!
 248          */
 249         public function characterHandler ($resource, $characters) {
 250                 // Trim all spaces away
 251                 $characters = trim($characters);
 252
 253                 // Is this string empty?
 254                 if (empty($characters)) {
 255                         // Then skip it silently
 256                         return false;
 257                 } // END - if
 258
 259                 // Assign the found characters to variable and use the last entry from
 260                 // stack as the name
 261                 parent::assignVariable($this->getStackerInstance()->getNamed('announcement'), $characters);
 262         }
 263
 264         /**
 265          * Handles the template dependency for given node
 266          *
 267          * @param       $node                                   The node we should load a dependency template
 268          * @param       $templateDependency             A template to load to satisfy dependencies
 269          * @return      void
 270          */
 271         private function handleTemplateDependency ($node, $templateDependency) {
 272                 // Is the template dependency set?
 273                 if ((!empty($templateDependency)) && (!isset($this->dependencyContent[$node]))) {
 274                         // Get a temporay template instance
 275                         $templateInstance = XmlTemplateEngineFactory::createXmlTemplateEngineInstance('node_announcement_template_class');
 276
 277                         // Then load it
 278                         $templateInstance->loadAnnouncementTemplate($templateDependency);
 279
 280                         // Parse the XML content
 281                         $templateInstance->renderXmlContent();
 282
 283                         // Save the parsed raw content in our dependency array
 284                         $this->dependencyContent[$node] = $templateInstance->getRawTemplateData();
 285                 } // END - if
 286         }
 287
 288         /**
 289          * Getter for cache file (FQFN)
 290          *
 291          * @return      $fqfn   Full-qualified file name of the menu cache
 292          */
 293         public function getMenuCacheFqfn () {
 294                 $this->partialStub('Please implement this method.');
 295         }
 296
 297         /**
 298          * Starts the announcement
 299          *
 300          * @return      void
 301          */
 302         private function startAnnouncement () {
 303                 // Push the node name on the stacker
 304                 $this->getStackerInstance()->pushNamed('announcement', 'announcement');
 305         }
 306
 307         /**
 308          * Starts the announcement data
 309          *
 310          * @return      void
 311          */
 312         private function startAnnouncementData () {
 313                 // Push the node name on the stacker
 314                 $this->getStackerInstance()->pushNamed('announcement', 'announcement-data');
 315         }
 316
 317         /**
 318          * Starts the node id
 319          *
 320          * @return      void
 321          */
 322         private function startNodeId () {
 323                 // Push the node name on the stacker
 324                 $this->getStackerInstance()->pushNamed('announcement', 'node-id');
 325         }
 326
 327         /**
 328          * Starts the node status
 329          *
 330          * @return      void
 331          */
 332         private function startNodeStatus () {
 333                 // Push the node name on the stacker
 334                 $this->getStackerInstance()->pushNamed('announcement', 'node-status');
 335         }
 336
 337         /**
 338          * Starts the listener
 339          *
 340          * @return      void
 341          */
 342         private function startListener () {
 343                 // Push the node name on the stacker
 344                 $this->getStackerInstance()->pushNamed('announcement', 'listener');
 345         }
 346
 347         /**
 348          * Starts the client listener
 349          *
 350          * @return      void
 351          */
 352         private function startClientListener () {
 353                 // Push the node name on the stacker
 354                 $this->getStackerInstance()->pushNamed('announcement', 'client-listener');
 355         }
 356
 357         /**
 358          * Starts the hub listener
 359          *
 360          * @return      void
 361          */
 362         private function startHubListener () {
 363                 // Push the node name on the stacker
 364                 $this->getStackerInstance()->pushNamed('announcement', 'hub-listener');
 365         }
 366
 367         /**
 368          * Starts the TCP port
 369          *
 370          * @return      void
 371          */
 372         private function startTcpPort () {
 373                 // Push the node name on the stacker
 374                 $this->getStackerInstance()->pushNamed('announcement', 'tcp-port');
 375         }
 376
 377         /**
 378          * Starts the UDP port
 379          *
 380          * @return      void
 381          */
 382         private function startUdpPort () {
 383                 // Push the node name on the stacker
 384                 $this->getStackerInstance()->pushNamed('announcement', 'udp-port');
 385         }
 386
 387         /**
 388          * Starts the session id
 389          *
 390          * @return      void
 391          */
 392         private function startSessionId () {
 393                 // Push the node name on the stacker
 394                 $this->getStackerInstance()->pushNamed('announcement', 'session-id');
 395         }
 396
 397         /**
 398          * Starts the object type list
 399          *
 400          * @return      void
 401          */
 402         private function startObjectTypeList () {
 403                 // Push the node name on the stacker
 404                 $this->getStackerInstance()->pushNamed('announcement', 'object-type-list');
 405         }
 406
 407         /**
 408          * Starts the object type
 409          *
 410          * @return      void
 411          */
 412         private function startObjectType () {
 413                 // Push the node name on the stacker
 414                 $this->getStackerInstance()->pushNamed('announcement', 'object-type');
 415         }
 416
 417         /**
 418          * Finishes the object type
 419          *
 420          * @return      void
 421          */
 422         private function finishObjectType () {
 423                 // Pop the last entry
 424                 $this->getStackerInstance()->popNamed('announcement');
 425         }
 426
 427         /**
 428          * Finishes the object type list
 429          *
 430          * @return      void
 431          */
 432         private function finishObjectTypeList () {
 433                 // Pop the last entry
 434                 $this->getStackerInstance()->popNamed('announcement');
 435         }
 436
 437         /**
 438          * Finishes the session id
 439          *
 440          * @return      void
 441          */
 442         private function finishSessionId () {
 443                 // Pop the last entry
 444                 $this->getStackerInstance()->popNamed('announcement');
 445         }
 446
 447         /**
 448          * Finishes the UDP port
 449          *
 450          * @return      void
 451          */
 452         private function finishUdpPort () {
 453                 // Pop the last entry
 454                 $this->getStackerInstance()->popNamed('announcement');
 455         }
 456
 457         /**
 458          * Finishes the TCP port
 459          *
 460          * @return      void
 461          */
 462         private function finishTcpPort () {
 463                 // Pop the last entry
 464                 $this->getStackerInstance()->popNamed('announcement');
 465         }
 466
 467         /**
 468          * Finishes the hub listener
 469          *
 470          * @return      void
 471          */
 472         private function finishHubListener () {
 473                 // Pop the last entry
 474                 $this->getStackerInstance()->popNamed('announcement');
 475         }
 476
 477         /**
 478          * Finishes the client listener
 479          *
 480          * @return      void
 481          */
 482         private function finishClientListener () {
 483                 // Pop the last entry
 484                 $this->getStackerInstance()->popNamed('announcement');
 485         }
 486
 487         /**
 488          * Finishes the listener
 489          *
 490          * @return      void
 491          */
 492         private function finishListener () {
 493                 // Pop the last entry
 494                 $this->getStackerInstance()->popNamed('announcement');
 495         }
 496
 497         /**
 498          * Finishes the node status
 499          *
 500          * @return      void
 501          */
 502         private function finishNodeStatus () {
 503                 // Pop the last entry
 504                 $this->getStackerInstance()->popNamed('announcement');
 505         }
 506
 507         /**
 508          * Finishes the node id
 509          *
 510          * @return      void
 511          */
 512         private function finishNodeId () {
 513                 // Pop the last entry
 514                 $this->getStackerInstance()->popNamed('announcement');
 515         }
 516
 517         /**
 518          * Finishes the announcement data
 519          *
 520          * @return      void
 521          */
 522         private function finishAnnouncementData () {
 523                 // Pop the last entry
 524                 $this->getStackerInstance()->popNamed('announcement');
 525         }
 526
 527         /**
 528          * Finishes the announcement
 529          *
 530          * @return      void
 531          */
 532         private function finishAnnouncement () {
 533                 // Pop the last entry
 534                 $this->getStackerInstance()->popNamed('announcement');
 535         }
 536 }
 537
 538 // [EOF]
 539 ?>