application/hub/main/template/answer/announcement/class_XmlAnnouncementAnswerTemplateEngine.php

   1 <?php
   2 /**
   3  * An ??? 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 - 2012 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 XmlAnnouncementAnswerTemplateEngine extends BaseTemplateEngine implements CompileableTemplate, Registerable {
  26         /**
  27          * Main nodes in the XML tree
  28          */
  29         private $mainNodes = array(
  30                 'announcement-answer'
  31         );
  32
  33         /**
  34          * Sub nodes in the XML tree
  35          */
  36         private $subNodes = array(
  37                 // These nodes don't contain any data
  38                 'node-data',
  39                 'other-data',
  40                 // Data from *this* node
  41                 'node-external-ip',
  42                 'node-internal-ip',
  43                 'node-tcp-port',
  44                 'node-udp-port',
  45                 'node-session-id',
  46                 'node-status',
  47                 // Data from other node
  48                 'other-external-ip',
  49                 'other-internal-ip',
  50                 'other-session-id',
  51                 // Answer status (code)
  52                 'answer-status'
  53         );
  54
  55         /**
  56          * Current main node
  57          */
  58         private $curr = array();
  59
  60         /**
  61          * Protected constructor
  62          *
  63          * @return      void
  64          */
  65         protected function __construct () {
  66                 // Call parent constructor
  67                 parent::__construct(__CLASS__);
  68         }
  69
  70         /**
  71          * Creates an instance of the class TemplateEngine and prepares it for usage
  72          *
  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
  79          *                                                                                      read-protected
  80          */
  81         public static final function createXmlAnnouncementAnswerTemplateEngine () {
  82                 // Get a new instance
  83                 $templateInstance = new XmlAnnouncementAnswerTemplateEngine();
  84
  85                 // Get application instance from registry
  86                 $applicationInstance = Registry::getRegistry()->getInstance('app');
  87
  88                 // Determine base path
  89                 $templateBasePath = $templateInstance->getConfigInstance()->getConfigEntry('application_base_path') . $applicationInstance->getRequestInstance()->getRequestElement('app') . '/';
  90
  91                 // Is the base path valid?
  92                 if (empty($templateBasePath)) {
  93                         // Base path is empty
  94                         throw new BasePathIsEmptyException($templateInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
  95                 } elseif (!is_string($templateBasePath)) {
  96                         // Is not a string
  97                         throw new InvalidBasePathStringException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_STRING);
  98                 } elseif (!is_dir($templateBasePath)) {
  99                         // Is not a path
 100                         throw new BasePathIsNoDirectoryException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_PATH_NAME);
 101                 } elseif (!is_readable($templateBasePath)) {
 102                         // Is not readable
 103                         throw new BasePathReadProtectedException(array($templateInstance, $templateBasePath), self::EXCEPTION_READ_PROTECED_PATH);
 104                 }
 105
 106                 // Set the base path
 107                 $templateInstance->setTemplateBasePath($templateBasePath);
 108
 109                 // Set template extensions
 110                 $templateInstance->setRawTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('raw_template_extension'));
 111                 $templateInstance->setCodeTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('node_answer_template_extension'));
 112
 113                 // Absolute output path for compiled templates
 114                 $templateInstance->setCompileOutputPath($templateInstance->getConfigInstance()->getConfigEntry('base_path') . $templateInstance->getConfigInstance()->getConfigEntry('compile_output_path'));
 115
 116                 // Init a variable stacker
 117                 $stackerInstance = ObjectFactory::createObjectByConfiguredName('node_announcement_answer_stacker_class');
 118
 119                 // Set it
 120                 $templateInstance->setStackerInstance($stackerInstance);
 121
 122                 // Return the prepared instance
 123                 return $templateInstance;
 124         }
 125
 126         /**
 127          * Load a specified announcement-answer template into the engine
 128          *
 129          * @param       $template       The announcement-answer template we shall load which is
 130          *                                              located in 'announcement_answer' by default
 131          * @return      void
 132          */
 133         public function loadAnnouncementAnswerTemplate ($template = 'announcement_answer') {
 134                 // Set template type
 135                 $this->setTemplateType($this->getConfigInstance()->getConfigEntry('node_announcement_answer_template_type'));
 136
 137                 // Load the special template
 138                 $this->loadTemplate($template);
 139         }
 140
 141         /**
 142          * Getter for current main node
 143          *
 144          * @return      $currMainNode   Current main node
 145          */
 146         public final function getCurrMainNode () {
 147                 return $this->curr['main_node'];
 148         }
 149
 150         /**
 151          * Setter for current main node
 152          *
 153          * @param       $element                Element name to set as current main node
 154          * @return      $currMainNode   Current main node
 155          */
 156         private final function setCurrMainNode ($element) {
 157                 $this->curr['main_node'] = (string) $element;
 158         }
 159
 160         /**
 161          * Getter for main node array
 162          *
 163          * @return      $mainNodes      Array with valid main node names
 164          */
 165         public final function getMainNodes () {
 166                 return $this->mainNodes;
 167         }
 168
 169         /**
 170          * Getter for sub node array
 171          *
 172          * @return      $subNodes       Array with valid sub node names
 173          */
 174         public final function getSubNodes () {
 175                 return $this->subNodes;
 176         }
 177
 178         /**
 179          * Handles the start element of an XML resource
 180          *
 181          * @param       $resource               XML parser resource (currently ignored)
 182          * @param       $element                The element we shall handle
 183          * @param       $attributes             All attributes
 184          * @return      void
 185          * @throws      InvalidXmlNodeException         If an unknown/invalid XML node name was found
 186          */
 187         public function startElement ($resource, $element, array $attributes) {
 188                 // Initial method name which will never be called...
 189                 $methodName = 'initAnnouncementAnswer';
 190
 191                 // Make the element name lower-case
 192                 $element = strtolower($element);
 193
 194                 // Is the element a main node?
 195                 //* DEBUG: */ echo "START: &gt;".$element."&lt;<br />\n";
 196                 if (in_array($element, $this->getMainNodes())) {
 197                         // Okay, main node found!
 198                         $methodName = 'start' . $this->convertToClassName($element);
 199
 200                         // Set it
 201                         $this->setCurrMainNode($element);
 202                 } elseif (in_array($element, $this->getSubNodes())) {
 203                         // Sub node found
 204                         $methodName = 'start' . $this->convertToClassName($element);
 205                 } else {
 206                         // Invalid node name found
 207                         throw new InvalidXmlNodeException(array($this, $element, $attributes), XmlParser::EXCEPTION_XML_NODE_UNKNOWN);
 208                 }
 209
 210                 // Call method
 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                 /*
 260                  * Assign the found characters to variable and use the last entry from
 261                  * stack as the name.
 262                  */
 263                 parent::assignVariable($this->getStackerInstance()->getNamed('announcement_answer'), $characters);
 264         }
 265
 266         /**
 267          * Getter for cache file (FQFN)
 268          *
 269          * @return      $fqfn   Full-qualified file name of the menu cache
 270          */
 271         public function getAnnouncementAnswerCacheFqfn () {
 272                 $this->partialStub('Please implement this method.');
 273         }
 274
 275         /**
 276          * Starts the announcement-answer
 277          *
 278          * @return      void
 279          */
 280         private function startAnnouncementAnswer () {
 281                 // Push the node name on the stacker
 282                 $this->getStackerInstance()->pushNamed('announcement_answer', 'announcement-answer');
 283         }
 284
 285         /**
 286          * Starts the node-data
 287          *
 288          * @return      void
 289          */
 290         private function startNodeData () {
 291                 // Push the node name on the stacker
 292                 $this->getStackerInstance()->pushNamed('announcement_answer', 'node-data');
 293         }
 294
 295         /**
 296          * Starts the node-external-ip
 297          *
 298          * @return      void
 299          */
 300         private function startNodeExternalIp () {
 301                 // Push the node name on the stacker
 302                 $this->getStackerInstance()->pushNamed('announcement_answer', 'node-external-ip');
 303         }
 304
 305         /**
 306          * Starts the node-internal-ip
 307          *
 308          * @return      void
 309          */
 310         private function startNodeInternalIp () {
 311                 // Push the node name on the stacker
 312                 $this->getStackerInstance()->pushNamed('announcement_answer', 'node-internal-ip');
 313         }
 314
 315         /**
 316          * Starts the node-tcp-port
 317          *
 318          * @return      void
 319          */
 320         private function startNodeTcpPort () {
 321                 // Push the node name on the stacker
 322                 $this->getStackerInstance()->pushNamed('announcement_answer', 'node-tcp-port');
 323         }
 324
 325         /**
 326          * Starts the node-udp-port
 327          *
 328          * @return      void
 329          */
 330         private function startNodeUdpPort () {
 331                 // Push the node name on the stacker
 332                 $this->getStackerInstance()->pushNamed('announcement_answer', 'node-udp-port');
 333         }
 334
 335         /**
 336          * Starts the node-session-id
 337          *
 338          * @return      void
 339          */
 340         private function startNodeSessionId () {
 341                 // Push the node name on the stacker
 342                 $this->getStackerInstance()->pushNamed('announcement_answer', 'node-session-id');
 343         }
 344
 345         /**
 346          * Starts the node-status
 347          *
 348          * @return      void
 349          */
 350         private function startNodeStatus () {
 351                 // Push the node name on the stacker
 352                 $this->getStackerInstance()->pushNamed('announcement_answer', 'node-status');
 353         }
 354
 355         /**
 356          * Finishes the node-status
 357          *
 358          * @return      void
 359          */
 360         private function finishNodeStatus () {
 361                 // Pop the last entry
 362                 $this->getStackerInstance()->popNamed('announcement_answer');
 363         }
 364
 365         /**
 366          * Finishes the node-session-id
 367          *
 368          * @return      void
 369          */
 370         private function finishNodeSessionId () {
 371                 // Pop the last entry
 372                 $this->getStackerInstance()->popNamed('announcement_answer');
 373         }
 374
 375         /**
 376          * Finishes the node-udp-port
 377          *
 378          * @return      void
 379          */
 380         private function finishNodeUdpPort () {
 381                 // Pop the last entry
 382                 $this->getStackerInstance()->popNamed('announcement_answer');
 383         }
 384
 385         /**
 386          * Finishes the node-tcp-port
 387          *
 388          * @return      void
 389          */
 390         private function finishNodeTcpPort () {
 391                 // Pop the last entry
 392                 $this->getStackerInstance()->popNamed('announcement_answer');
 393         }
 394
 395         /**
 396          * Finishes the node-internal-ip
 397          *
 398          * @return      void
 399          */
 400         private function finishNodeInternalIp () {
 401                 // Pop the last entry
 402                 $this->getStackerInstance()->popNamed('announcement_answer');
 403         }
 404
 405         /**
 406          * Finishes the node-external-ip
 407          *
 408          * @return      void
 409          */
 410         private function finishNodeExternalIp () {
 411                 // Pop the last entry
 412                 $this->getStackerInstance()->popNamed('announcement_answer');
 413         }
 414
 415         /**
 416          * Finishes the node-data
 417          *
 418          * @return      void
 419          */
 420         private function finishNodeData () {
 421                 // Pop the last entry
 422                 $this->getStackerInstance()->popNamed('announcement_answer');
 423         }
 424
 425         /**
 426          * Starts the other-data
 427          *
 428          * @return      void
 429          */
 430         private function startOtherData () {
 431                 // Push the node name on the stacker
 432                 $this->getStackerInstance()->pushNamed('announcement_answer', 'other-data');
 433         }
 434
 435         /**
 436          * Starts the other-external-ip
 437          *
 438          * @return      void
 439          */
 440         private function startOtherExternalIp () {
 441                 // Push the node name on the stacker
 442                 $this->getStackerInstance()->pushNamed('announcement_answer', 'other-external-ip');
 443         }
 444
 445         /**
 446          * Starts the other-internal-ip
 447          *
 448          * @return      void
 449          */
 450         private function startOtherInternalIp () {
 451                 // Push the node name on the stacker
 452                 $this->getStackerInstance()->pushNamed('announcement_answer', 'other-internal-ip');
 453         }
 454
 455         /**
 456          * Starts the other-session-id
 457          *
 458          * @return      void
 459          */
 460         private function startOtherSessionId () {
 461                 // Push the node name on the stacker
 462                 $this->getStackerInstance()->pushNamed('announcement_answer', 'other-session-id');
 463         }
 464
 465         /**
 466          * Finishes the other-session-id
 467          *
 468          * @return      void
 469          */
 470         private function finishOtherSessionId () {
 471                 // Pop the last entry
 472                 $this->getStackerInstance()->popNamed('announcement_answer');
 473         }
 474
 475         /**
 476          * Finishes the other-internal-ip
 477          *
 478          * @return      void
 479          */
 480         private function finishOtherInternalIp () {
 481                 // Pop the last entry
 482                 $this->getStackerInstance()->popNamed('announcement_answer');
 483         }
 484
 485         /**
 486          * Finishes the other-external-ip
 487          *
 488          * @return      void
 489          */
 490         private function finishOtherExternalIp () {
 491                 // Pop the last entry
 492                 $this->getStackerInstance()->popNamed('announcement_answer');
 493         }
 494
 495         /**
 496          * Finishes the other-data
 497          *
 498          * @return      void
 499          */
 500         private function finishOtherData () {
 501                 // Pop the last entry
 502                 $this->getStackerInstance()->popNamed('announcement_answer');
 503         }
 504
 505         /**
 506          * Starts the answer-status
 507          *
 508          * @return      void
 509          */
 510         private function startAnswerStatus () {
 511                 // Push the node name on the stacker
 512                 $this->getStackerInstance()->pushNamed('announcement_answer', 'answer-status');
 513         }
 514
 515         /**
 516          * Finishes the answer-status
 517          *
 518          * @return      void
 519          */
 520         private function finishAnswerStatus () {
 521                 // Pop the last entry
 522                 $this->getStackerInstance()->popNamed('announcement_answer');
 523         }
 524
 525         /**
 526          * Finishes the announcement-answer
 527          *
 528          * @return      void
 529          */
 530         private function finishAnnouncementAnswer () {
 531                 // Pop the last entry
 532                 $this->getStackerInstance()->popNamed('announcement_answer');
 533         }
 534 }
 535
 536 // [EOF]
 537 ?>