application/hub/main/template/answer/requests/class_XmlRequestNodeListAnswerTemplateEngine.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 XmlRequestNodeListAnswerTemplateEngine extends BaseXmlTemplateEngine implements CompileableTemplate, Registerable {
  26         /**
  27          * Protected constructor
  28          *
  29          * @return      void
  30          */
  31         protected function __construct () {
  32                 // Call parent constructor
  33                 parent::__construct(__CLASS__);
  34
  35                 // Init sub-nodes array
  36                 $this->subNodes = array(
  37                         XmlRequestNodeListTemplateEngine::REQUEST_DATA_ACCEPTED_OBJECT_TYPES,
  38                         XmlRequestNodeListTemplateEngine::REQUEST_DATA_SESSION_ID,
  39                 );
  40         }
  41
  42         /**
  43          * Creates an instance of the class TemplateEngine and prepares it for usage
  44          *
  45          * @return      $templateInstance               An instance of TemplateEngine
  46          * @throws      BasePathIsEmptyException                If the provided $templateBasePath is empty
  47          * @throws      InvalidBasePathStringException  If $templateBasePath is no string
  48          * @throws      BasePathIsNoDirectoryException  If $templateBasePath is no
  49          *                                                                                      directory or not found
  50          * @throws      BasePathReadProtectedException  If $templateBasePath is
  51          *                                                                                      read-protected
  52          */
  53         public static final function createXmlRequestNodeListAnswerTemplateEngine () {
  54                 // Get a new instance
  55                 $templateInstance = new XmlRequestNodeListAnswerTemplateEngine();
  56
  57                 // Init instance
  58                 $templateInstance->initXmlTemplateEngine('node', 'request_node_list_answer');
  59
  60                 // Return the prepared instance
  61                 return $templateInstance;
  62         }
  63
  64         /**
  65          * Currently not used
  66          *
  67          * @param       $resource               XML parser resource (currently ignored)
  68          * @param       $characters             Characters to handle
  69          * @return      void
  70          * @todo        Find something useful with this!
  71          */
  72         public function characterHandler ($resource, $characters) {
  73                 // Trim all spaces away
  74                 $characters = trim($characters);
  75
  76                 // Is this string empty?
  77                 if (empty($characters)) {
  78                         // Then skip it silently
  79                         return false;
  80                 } // END - if
  81
  82                 /*
  83                  * Assign the found characters to variable and use the last entry from
  84                  * stack as the name.
  85                  */
  86                 parent::assignVariable($this->getStackerInstance()->getNamed('node_request_node_list_answer'), $characters);
  87         }
  88
  89         /**
  90          * Getter for cache file (FQFN)
  91          *
  92          * @return      $fqfn   Full-qualified file name of the menu cache
  93          */
  94         public function getRequestNodeListAnswerCacheFqfn () {
  95                 $this->partialStub('Please implement this method.');
  96         }
  97
  98         /**
  99          * Starts the 'request-node-list-answer'
 100          *
 101          * @return      void
 102          */
 103         protected function startRequestNodeListAnswer () {
 104                 // Push the node name on the stacker
 105                 $this->getStackerInstance()->pushNamed('node_request_node_list_answer', 'request-node-list-answer');
 106         }
 107
 108         /**
 109          * Finishes the 'request-node-list-answer'
 110          *
 111          * @return      void
 112          */
 113         protected function finishRequestNodeListAnswer () {
 114                 // Pop the last entry
 115                 $this->getStackerInstance()->popNamed('node_request_node_list_answer');
 116         }
 117 }
 118
 119 // [EOF]
 120 ?>