3 * A generic XML template engine class
5 * @author Roland Haeder <webmaster@ship-simu.org>
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()
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 BaseXmlTemplateEngine extends BaseTemplateEngine {
27 * Main nodes in the XML tree
29 protected $mainNodes = array();
32 * Sub nodes in the XML tree
34 protected $subNodes = array();
39 protected $curr = array();
44 private $xmlTemplateType = 'xml';
49 private $typePrefix = 'xml';
52 * Content from dependency
54 protected $dependencyContent = array();
57 * Protected constructor
59 * @param $className Name of the class
62 protected function __construct ($className) {
63 // Call parent constructor
64 parent::__construct($className);
68 * Does a generic initialization of the template engine
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
80 protected function initXmlTemplateEngine ($typePrefix, $xmlTemplateType) {
81 // Get template instance
82 $applicationInstance = Registry::getRegistry()->getInstance('app');
84 // Determine base path
85 $templateBasePath = $this->getConfigInstance()->getConfigEntry('application_base_path') . $applicationInstance->getRequestInstance()->getRequestElement('app') . '/';
87 // Is the base path valid?
88 if (empty($templateBasePath)) {
90 throw new BasePathIsEmptyException($this, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
91 } elseif (!is_string($templateBasePath)) {
93 throw new InvalidBasePathStringException(array($this, $templateBasePath), self::EXCEPTION_INVALID_STRING);
94 } elseif (!is_dir($templateBasePath)) {
96 throw new BasePathIsNoDirectoryException(array($this, $templateBasePath), self::EXCEPTION_INVALID_PATH_NAME);
97 } elseif (!is_readable($templateBasePath)) {
99 throw new BasePathReadProtectedException(array($this, $templateBasePath), self::EXCEPTION_READ_PROTECED_PATH);
103 $this->setTemplateBasePath($templateBasePath);
105 // Set template extensions
106 $this->setRawTemplateExtension($this->getConfigInstance()->getConfigEntry('raw_template_extension'));
107 $this->setCodeTemplateExtension($this->getConfigInstance()->getConfigEntry($typePrefix . '_message_template_extension'));
109 // Absolute output path for compiled templates
110 $this->setCompileOutputPath($this->getConfigInstance()->getConfigEntry('base_path') . $this->getConfigInstance()->getConfigEntry('compile_output_path'));
112 // Init a variable stacker
113 $stackerInstance = ObjectFactory::createObjectByConfiguredName($typePrefix . '_' . $xmlTemplateType . '_stacker_class');
116 $stackerInstance->initStacker($typePrefix . '_' . $xmlTemplateType);
119 $this->setStackerInstance($stackerInstance);
121 // Set XML template type and prefix
122 $this->xmlTemplateType = $xmlTemplateType;
123 $this->typePrefix = $typePrefix;
125 // Set it in main nodes
126 array_push($this->mainNodes, str_replace('_', '-', $xmlTemplateType));
130 * Load a specified XML template into the engine
132 * @param $templateName Optional name of template
135 public function loadXmlTemplate ($templateName = '') {
136 // Is the template name empty?
137 if (empty($templateName)) {
138 // Set generic template name
139 $templateName = $this->typePrefix . '_' . $this->xmlTemplateType . '_template_type';
143 $this->setTemplateType($this->getConfigInstance()->getConfigEntry($templateName));
145 // Load the special template
146 $this->loadTemplate($this->xmlTemplateType);
150 * Getter for current main node
152 * @return $currMainNode Current main node
154 public final function getCurrMainNode () {
155 return $this->curr['main_node'];
159 * Setter for current main node
161 * @param $element Element name to set as current main node
162 * @return $currMainNode Current main node
164 private final function setCurrMainNode ($element) {
165 $this->curr['main_node'] = (string) $element;
169 * Getter for main node array
171 * @return $mainNodes Array with valid main node names
173 public final function getMainNodes () {
174 return $this->mainNodes;
178 * Getter for sub node array
180 * @return $subNodes Array with valid sub node names
182 public final function getSubNodes () {
183 return $this->subNodes;
187 * Read XML variables by calling readVariable() with 'general' as
190 * @param $key Key to read from
191 * @return $value Value from variable
193 public function readXmlData ($key) {
195 $value = parent::readVariable($key, 'general');
202 * Handles the template dependency for given node
204 * @param $node The node we should load a dependency template
205 * @param $templateDependency A template to load to satisfy dependencies
208 protected function handleTemplateDependency ($node, $templateDependency) {
209 // Check that node is not empty
210 assert(!empty($node));
212 // Is the template dependency set?
213 if ((!empty($templateDependency)) && (!isset($this->dependencyContent[$node]))) {
214 // Get a temporay template instance
215 $templateInstance = XmlTemplateEngineFactory::createXmlTemplateEngineInstance($this->typePrefix . '_' . $this->convertDashesToUnderscores($node) . '_' . $this->xmlTemplateType . '_template_class');
218 $templateInstance->loadXmlTemplate($templateDependency);
220 // Parse the XML content
221 $templateInstance->renderXmlContent();
223 // Save the parsed raw content in our dependency array
224 $this->dependencyContent[$node] = $templateInstance->getRawTemplateData();
229 * Handles the start element of an XML resource
231 * @param $resource XML parser resource (currently ignored)
232 * @param $element The element we shall handle
233 * @param $attributes All attributes
235 * @throws InvalidXmlNodeException If an unknown/invalid XML node name was found
237 public final function startElement ($resource, $element, array $attributes) {
238 // Initial method name which will never be called...
239 $methodName = 'init' . $this->convertToClassName($this->xmlTemplateType);
241 // Make the element name lower-case
242 $element = strtolower($element);
244 // Is the element a main node?
245 //* DEBUG: */ echo "START: >".$element."<<br />\n";
246 if (in_array($element, $this->getMainNodes())) {
247 // Okay, main node found!
248 $methodName = 'start' . $this->convertToClassName($element);
251 $this->setCurrMainNode($element);
252 } elseif (in_array($element, $this->getSubNodes())) {
254 $methodName = 'start' . $this->convertToClassName($element);
256 // Invalid node name found
257 throw new InvalidXmlNodeException(array($this, $element, $attributes), XmlParser::EXCEPTION_XML_NODE_UNKNOWN);
261 call_user_func_array(array($this, $methodName), $attributes);
265 * Ends the main or sub node by sending out the gathered data
267 * @param $resource An XML resource pointer (currently ignored)
268 * @param $nodeName Name of the node we want to finish
270 * @throws XmlNodeMismatchException If current main node mismatches the closing one
272 public final function endElement ($resource, $nodeName) {
273 // Make all lower-case
274 $nodeName = strtolower($nodeName);
276 // Does this match with current main node?
277 //* DEBUG: */ echo "END: >".$nodeName."<<br />\n";
278 if (($nodeName != $this->getCurrMainNode()) && (in_array($nodeName, $this->getMainNodes()))) {
280 throw new XmlNodeMismatchException (array($this, $nodeName, $this->getCurrMainNode()), XmlParser::EXCEPTION_XML_NODE_MISMATCH);
283 // Construct method name
284 $methodName = 'finish' . $this->convertToClassName($nodeName);
286 // Call the corresponding method
287 //* DEBUG: */ echo "call: ".$methodName."<br />\n";
288 call_user_func_array(array($this, $methodName), array());