3 * An SelfConnect template engine class for XML templates
5 * @author Roland Haeder <webmaster@ship-simu.org>
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()
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 XmlSelfConnectTemplateEngine extends BaseTemplateEngine implements CompileableTemplate {
27 * Main nodes in the XML tree
29 private $mainNodes = array(
34 * Sub nodes in the XML tree
36 private $subNodes = array(
45 private $curr = array();
48 * Content from dependency
50 private $dependencyContent = array();
53 * Protected constructor
57 protected function __construct () {
58 // Call parent constructor
59 parent::__construct(__CLASS__);
63 * Creates an instance of the class TemplateEngine and prepares it for usage
65 * @param $applicationInstance A manageable application
66 * @return $templateInstance An instance of TemplateEngine
67 * @throws BasePathIsEmptyException If the provided $templateBasePath is empty
68 * @throws InvalidBasePathStringException If $templateBasePath is no string
69 * @throws BasePathIsNoDirectoryException If $templateBasePath is no
70 * directory or not found
71 * @throws BasePathReadProtectedException If $templateBasePath is
74 public static final function createXmlSelfConnectTemplateEngine (ManageableApplication $applicationInstance) {
76 $templateInstance = new XmlSelfConnectTemplateEngine();
78 // Determine base path
79 $templateBasePath = $templateInstance->getConfigInstance()->getConfigEntry('application_base_path') . $applicationInstance->getRequestInstance()->getRequestElement('app') . '/';
81 // Is the base path valid?
82 if (empty($templateBasePath)) {
84 throw new BasePathIsEmptyException($templateInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
85 } elseif (!is_string($templateBasePath)) {
87 throw new InvalidBasePathStringException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_STRING);
88 } elseif (!is_dir($templateBasePath)) {
90 throw new BasePathIsNoDirectoryException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_PATH_NAME);
91 } elseif (!is_readable($templateBasePath)) {
93 throw new BasePathReadProtectedException(array($templateInstance, $templateBasePath), self::EXCEPTION_READ_PROTECED_PATH);
97 $templateInstance->setTemplateBasePath($templateBasePath);
99 // Set template extensions
100 $templateInstance->setRawTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('raw_template_extension'));
101 $templateInstance->setCodeTemplateExtension($templateInstance->getConfigInstance()->getConfigEntry('self_connect_template_extension'));
103 // Absolute output path for compiled templates
104 $templateInstance->setCompileOutputPath($templateInstance->getConfigInstance()->getConfigEntry('base_path') . $templateInstance->getConfigInstance()->getConfigEntry('compile_output_path'));
106 // Init a variable stacker
107 $stackerInstance = ObjectFactory::createObjectByConfiguredName('self_connect_stacker_class');
110 $templateInstance->setStackerInstance($stackerInstance);
112 // Return the prepared instance
113 return $templateInstance;
117 * Load a specified self-connect template into the engine
119 * @param $template The self-connect template we shall load which is
120 * located in 'self_connect' by default
123 public function loadSelfConnectTemplate ($template = 'self_connect') {
125 $this->setTemplateType($this->getConfigInstance()->getConfigEntry('self_connect_template_type'));
127 // Load the special template
128 $this->loadTemplate($template);
132 * Getter for current main node
134 * @return $currMainNode Current main node
136 public final function getCurrMainNode () {
137 return $this->curr['main_node'];
141 * Setter for current main node
143 * @param $element Element name to set as current main node
144 * @return $currMainNode Current main node
146 private final function setCurrMainNode ($element) {
147 $this->curr['main_node'] = (string) $element;
151 * Getter for main node array
153 * @return $mainNodes Array with valid main node names
155 public final function getMainNodes () {
156 return $this->mainNodes;
160 * Getter for sub node array
162 * @return $subNodes Array with valid sub node names
164 public final function getSubNodes () {
165 return $this->subNodes;
169 * Handles the start element of an XML resource
171 * @param $resource XML parser resource (currently ignored)
172 * @param $element The element we shall handle
173 * @param $attributes All attributes
175 * @throws InvalidXmlNodeException If an unknown/invalid XML node name was found
177 public function startElement ($resource, $element, array $attributes) {
178 // Initial method name which will never be called...
179 $methodName = 'initSelfConnect';
181 // Make the element name lower-case
182 $element = strtolower($element);
184 // Is the element a main node?
185 //* DEBUG: */ echo "START: >".$element."<<br />\n";
186 if (in_array($element, $this->getMainNodes())) {
187 // Okay, main node found!
188 $methodName = 'start' . $this->convertToClassName($element);
191 $this->setCurrMainNode($element);
192 } elseif (in_array($element, $this->getSubNodes())) {
194 $methodName = 'start' . $this->convertToClassName($element);
196 // Invalid node name found
197 throw new InvalidXmlNodeException(array($this, $element, $attributes), XmlParser::EXCEPTION_XML_NODE_UNKNOWN);
201 //* DEBUG: */ echo "call: ".$methodName."<br />\n";
202 call_user_func_array(array($this, $methodName), $attributes);
206 * Ends the main or sub node by sending out the gathered data
208 * @param $resource An XML resource pointer (currently ignored)
209 * @param $nodeName Name of the node we want to finish
211 * @throws XmlNodeMismatchException If current main node mismatches the closing one
213 public function endElement ($resource, $nodeName) {
214 // Make all lower-case
215 $nodeName = strtolower($nodeName);
217 // Does this match with current main node?
218 //* DEBUG: */ echo "END: >".$nodeName."<<br />\n";
219 if (($nodeName != $this->getCurrMainNode()) && (in_array($nodeName, $this->getMainNodes()))) {
221 throw new XmlNodeMismatchException (array($this, $nodeName, $this->getCurrMainNode()), XmlParser::EXCEPTION_XML_NODE_MISMATCH);
224 // Construct method name
225 $methodName = 'finish' . $this->convertToClassName($nodeName);
227 // Call the corresponding method
228 //* DEBUG: */ echo "call: ".$methodName."<br />\n";
229 call_user_func_array(array($this, $methodName), array());
235 * @param $resource XML parser resource (currently ignored)
236 * @param $characters Characters to handle
238 * @todo Find something useful with this!
240 public function characterHandler ($resource, $characters) {
241 // Trim all spaces away
242 $characters = trim($characters);
244 // Is this string empty?
245 if (empty($characters)) {
246 // Then skip it silently
250 // Assign the found characters to variable and use the last entry from
252 parent::assignVariable($this->getStackerInstance()->getNamed('self_connect'), $characters);
256 * Handles the template dependency for given node
258 * @param $node The node we should load a dependency template
259 * @param $templateDependency A template to load to satisfy dependencies
262 private function handleTemplateDependency ($node, $templateDependency) {
263 // Is the template dependency set?
264 if ((!empty($templateDependency)) && (!isset($this->dependencyContent[$node]))) {
265 // Get a temporay template instance
266 $templateInstance = ObjectFactory::createObjectByConfiguredName('self_connect_template_class', array($this->getApplicationInstance()));
269 $templateInstance->loadSelfConnectTemplate($templateDependency);
271 // Parse the XML content
272 $templateInstance->renderXmlContent();
274 // Save the parsed raw content in our dependency array
275 $this->dependencyContent[$node] = $templateInstance->getRawTemplateData();
280 * Getter for cache file (FQFN)
282 * @return $fqfn Full-qualified file name of the menu cache
284 public function getMenuCacheFqfn () {
285 $this->partialStub('Please implement this method.');
289 * Starts the self_connect
293 private function startSelfConnect () {
294 // Push the node name on the stacker
295 $this->getStackerInstance()->pushNamed('self_connect', 'self-connect');
299 * Starts the self_connect data
303 private function startSelfConnectData () {
304 // Push the node name on the stacker
305 $this->getStackerInstance()->pushNamed('self_connect', 'self-connect-data');
313 private function startNodeId () {
314 // Push the node name on the stacker
315 $this->getStackerInstance()->pushNamed('self_connect', 'node-id');
319 * Starts the session id
323 private function startSessionId () {
324 // Push the node name on the stacker
325 $this->getStackerInstance()->pushNamed('self_connect', 'session-id');
329 * Finishes the session id
333 private function finishSessionId () {
334 // Pop the last entry
335 $this->getStackerInstance()->popNamed('self_connect');
339 * Finishes the node id
343 private function finishNodeId () {
344 // Pop the last entry
345 $this->getStackerInstance()->popNamed('self_connect');
349 * Finishes the self_connect data
353 private function finishSelfConnectData () {
354 // Pop the last entry
355 $this->getStackerInstance()->popNamed('self_connect');
359 * Finishes the self_connect
363 private function finishSelfConnect () {
364 // Pop the last entry
365 $this->getStackerInstance()->popNamed('self_connect');