application/hub/main/template/class_BaseXmlTemplateEngine.php

   1 <?php
   2 /**
   3  * A generic XML template engine class
   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 BaseXmlTemplateEngine extends BaseTemplateEngine {
  26         /**
  27          * Main nodes in the XML tree
  28          */
  29         protected $mainNodes = array();
  30
  31         /**
  32          * Sub nodes in the XML tree
  33          */
  34         protected $subNodes = array();
  35
  36         /**
  37          * Current main node
  38          */
  39         protected $curr = array();
  40
  41         /**
  42          * XML template type
  43          */
  44         private $xmlTemplateType = 'xml';
  45
  46         /**
  47          * Type prefix
  48          */
  49         private $typePrefix = 'xml';
  50
  51         /**
  52          * Content from dependency
  53          */
  54         protected $dependencyContent = array();
  55
  56         /**
  57          * Protected constructor
  58          *
  59          * @param       $className      Name of the class
  60          * @return      void
  61          */
  62         protected function __construct ($className) {
  63                 // Call parent constructor
  64                 parent::__construct($className);
  65         }
  66
  67         /**
  68          * Does a generic initialization of the template engine
  69          *
  70          * @param       $typePrefix                             Type prefix
  71          * @param       $xmlTemplateType                Type of XML template
  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         protected function initXmlTemplateEngine ($typePrefix, $xmlTemplateType) {
  81                 // Get template instance
  82                 $applicationInstance = Registry::getRegistry()->getInstance('app');
  83
  84                 // Determine base path
  85                 $templateBasePath = $this->getConfigInstance()->getConfigEntry('application_base_path') . $applicationInstance->getRequestInstance()->getRequestElement('app') . '/';
  86
  87                 // Is the base path valid?
  88                 if (empty($templateBasePath)) {
  89                         // Base path is empty
  90                         throw new BasePathIsEmptyException($this, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
  91                 } elseif (!is_string($templateBasePath)) {
  92                         // Is not a string
  93                         throw new InvalidBasePathStringException(array($this, $templateBasePath), self::EXCEPTION_INVALID_STRING);
  94                 } elseif (!is_dir($templateBasePath)) {
  95                         // Is not a path
  96                         throw new BasePathIsNoDirectoryException(array($this, $templateBasePath), self::EXCEPTION_INVALID_PATH_NAME);
  97                 } elseif (!is_readable($templateBasePath)) {
  98                         // Is not readable
  99                         throw new BasePathReadProtectedException(array($this, $templateBasePath), self::EXCEPTION_READ_PROTECED_PATH);
 100                 }
 101
 102                 // Set the base path
 103                 $this->setTemplateBasePath($templateBasePath);
 104
 105                 // Set template extensions
 106                 $this->setRawTemplateExtension($this->getConfigInstance()->getConfigEntry('raw_template_extension'));
 107                 $this->setCodeTemplateExtension($this->getConfigInstance()->getConfigEntry($typePrefix . '_message_template_extension'));
 108
 109                 // Absolute output path for compiled templates
 110                 $this->setCompileOutputPath($this->getConfigInstance()->getConfigEntry('base_path') . $this->getConfigInstance()->getConfigEntry('compile_output_path'));
 111
 112                 // Init a variable stacker
 113                 $stackerInstance = ObjectFactory::createObjectByConfiguredName($typePrefix . '_' . $xmlTemplateType . '_stacker_class');
 114
 115                 // Init stacker
 116                 $stackerInstance->initStacker($xmlTemplateType);
 117
 118                 // Set it
 119                 $this->setStackerInstance($stackerInstance);
 120
 121                 // Set XML template type and prefix
 122                 $this->xmlTemplateType = $xmlTemplateType;
 123                 $this->typePrefix      = $typePrefix;
 124
 125                 // Set it in main nodes
 126                 array_push($this->mainNodes, str_replace('_', '-', $xmlTemplateType));
 127         }
 128
 129         /**
 130          * Load a specified XML template into the engine
 131          *
 132          * @return      void
 133          */
 134         public function loadXmlTemplate () {
 135                 // Set template type
 136                 $this->setTemplateType($this->getConfigInstance()->getConfigEntry($this->typePrefix . '_' . $this->xmlTemplateType . '_template_type'));
 137
 138                 // Load the special template
 139                 $this->loadTemplate($this->xmlTemplateType);
 140         }
 141
 142         /**
 143          * Getter for current main node
 144          *
 145          * @return      $currMainNode   Current main node
 146          */
 147         public final function getCurrMainNode () {
 148                 return $this->curr['main_node'];
 149         }
 150
 151         /**
 152          * Setter for current main node
 153          *
 154          * @param       $element                Element name to set as current main node
 155          * @return      $currMainNode   Current main node
 156          */
 157         private final function setCurrMainNode ($element) {
 158                 $this->curr['main_node'] = (string) $element;
 159         }
 160
 161         /**
 162          * Getter for main node array
 163          *
 164          * @return      $mainNodes      Array with valid main node names
 165          */
 166         public final function getMainNodes () {
 167                 return $this->mainNodes;
 168         }
 169
 170         /**
 171          * Getter for sub node array
 172          *
 173          * @return      $subNodes       Array with valid sub node names
 174          */
 175         public final function getSubNodes () {
 176                 return $this->subNodes;
 177         }
 178
 179         /**
 180          * Read XML variables by calling readVariable() with 'general' as
 181          * variable stack.
 182          *
 183          * @param       $key    Key to read from
 184          * @return      $value  Value from variable
 185          */
 186         public function readXmlData ($key) {
 187                 // Read the variable
 188                 $value = parent::readVariable($key, 'general');
 189
 190                 // Return value
 191                 return $value;
 192         }
 193
 194         /**
 195          * Handles the template dependency for given node
 196          *
 197          * @param       $node                                   The node we should load a dependency template
 198          * @param       $templateDependency             A template to load to satisfy dependencies
 199          * @return      void
 200          */
 201         protected function handleTemplateDependency ($node, $templateDependency) {
 202                 // Is the template dependency set?
 203                 if ((!empty($templateDependency)) && (!isset($this->dependencyContent[$node]))) {
 204                         // Get a temporay template instance
 205                         $templateInstance = XmlTemplateEngineFactory::createXmlTemplateEngineInstance($this->typePrefix . '__' . $this->xmlTemplateType . '_template_class');
 206
 207                         // Create method name
 208                         $methodName = 'load' . $this->convertToClassName($this->xmlTemplateType) . 'Template';
 209
 210                         // Then load it
 211                         call_user_func(array($templateInstance, $methodName), $templateDependency);
 212
 213                         // Parse the XML content
 214                         $templateInstance->renderXmlContent();
 215
 216                         // Save the parsed raw content in our dependency array
 217                         $this->dependencyContent[$node] = $templateInstance->getRawTemplateData();
 218                 } // END - if
 219         }
 220
 221         /**
 222          * Handles the start element of an XML resource
 223          *
 224          * @param       $resource               XML parser resource (currently ignored)
 225          * @param       $element                The element we shall handle
 226          * @param       $attributes             All attributes
 227          * @return      void
 228          * @throws      InvalidXmlNodeException         If an unknown/invalid XML node name was found
 229          */
 230         public final function startElement ($resource, $element, array $attributes) {
 231                 // Initial method name which will never be called...
 232                 $methodName = 'init' . $this->convertToClassName($this->xmlTemplateType);
 233
 234                 // Make the element name lower-case
 235                 $element = strtolower($element);
 236
 237                 // Is the element a main node?
 238                 //* DEBUG: */ echo "START: &gt;".$element."&lt;<br />\n";
 239                 if (in_array($element, $this->getMainNodes())) {
 240                         // Okay, main node found!
 241                         $methodName = 'start' . $this->convertToClassName($element);
 242
 243                         // Set it
 244                         $this->setCurrMainNode($element);
 245                 } elseif (in_array($element, $this->getSubNodes())) {
 246                         // Sub node found
 247                         $methodName = 'start' . $this->convertToClassName($element);
 248                 } else {
 249                         // Invalid node name found
 250                         throw new InvalidXmlNodeException(array($this, $element, $attributes), XmlParser::EXCEPTION_XML_NODE_UNKNOWN);
 251                 }
 252
 253                 // Call method
 254                 call_user_func_array(array($this, $methodName), $attributes);
 255         }
 256
 257         /**
 258          * Ends the main or sub node by sending out the gathered data
 259          *
 260          * @param       $resource       An XML resource pointer (currently ignored)
 261          * @param       $nodeName       Name of the node we want to finish
 262          * @return      void
 263          * @throws      XmlNodeMismatchException        If current main node mismatches the closing one
 264          */
 265         public final function endElement ($resource, $nodeName) {
 266                 // Make all lower-case
 267                 $nodeName = strtolower($nodeName);
 268
 269                 // Does this match with current main node?
 270                 //* DEBUG: */ echo "END: &gt;".$nodeName."&lt;<br />\n";
 271                 if (($nodeName != $this->getCurrMainNode()) && (in_array($nodeName, $this->getMainNodes()))) {
 272                         // Did not match!
 273                         throw new XmlNodeMismatchException (array($this, $nodeName, $this->getCurrMainNode()), XmlParser::EXCEPTION_XML_NODE_MISMATCH);
 274                 } // END - if
 275
 276                 // Construct method name
 277                 $methodName = 'finish' . $this->convertToClassName($nodeName);
 278
 279                 // Call the corresponding method
 280                 //* DEBUG: */ echo "call: ".$methodName."<br />\n";
 281                 call_user_func_array(array($this, $methodName), array());
 282         }
 283 }
 284
 285 // [EOF]
 286 ?>