3 * A Menu template engine class
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.ship-simu.org
11 * This program is free software: you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License as published by
13 * the Free Software Foundation, either version 3 of the License, or
14 * (at your option) any later version.
16 * This program is distributed in the hope that it will be useful,
17 * but WITHOUT ANY WARRANTY; without even the implied warranty of
18 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
19 * GNU General Public License for more details.
21 * You should have received a copy of the GNU General Public License
22 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTemplate {
26 * Main nodes in the XML tree ('menu' is ignored)
28 private $mainNodes = array(
33 * Sub nodes in the XML tree
35 private $subNodes = array(
63 private $menuInstance = null;
68 private $curr = array();
71 * Content from dependency
73 private $dependencyContent = array();
76 * Protected constructor
80 protected function __construct () {
81 // Call parent constructor
82 parent::__construct(__CLASS__);
86 * Creates an instance of the class TemplateEngine and prepares it for usage
88 * @param $appInstance A manageable application
89 * @param $menuInstance A RenderableMenu instance
90 * @return $templateInstance An instance of TemplateEngine
91 * @throws BasePathIsEmptyException If the provided $templateBasePath is empty
92 * @throws InvalidBasePathStringException If $templateBasePath is no string
93 * @throws BasePathIsNoDirectoryException If $templateBasePath is no
94 * directory or not found
95 * @throws BasePathReadProtectedException If $templateBasePath is
98 public final static function createMenuTemplateEngine (ManageableApplication $appInstance, RenderableMenu $menuInstance) {
100 $templateInstance = new MenuTemplateEngine();
102 // Get language and file I/O instances from application
103 $langInstance = $appInstance->getLanguageInstance();
104 $ioInstance = $appInstance->getFileIoInstance();
106 // Determine base path
107 $templateBasePath = $templateInstance->getConfigInstance()->getConfigEntry('application_base_path') . $appInstance->getRequestInstance()->getRequestElement('app') . '/';
109 // Is the base path valid?
110 if (empty($templateBasePath)) {
111 // Base path is empty
112 throw new BasePathIsEmptyException($templateInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
113 } elseif (!is_string($templateBasePath)) {
115 throw new InvalidBasePathStringException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_STRING);
116 } elseif (!is_dir($templateBasePath)) {
118 throw new BasePathIsNoDirectoryException(array($templateInstance, $templateBasePath), self::EXCEPTION_INVALID_PATH_NAME);
119 } elseif (!is_readable($templateBasePath)) {
121 throw new BasePathReadProtectedException(array($templateInstance, $templateBasePath), self::EXCEPTION_READ_PROTECED_PATH);
124 // Get configuration instance
125 $configInstance = FrameworkConfiguration::getInstance();
128 $templateInstance->setTemplateBasePath($templateBasePath);
130 // Set the language and IO instances
131 $templateInstance->setLanguageInstance($langInstance);
132 $templateInstance->setFileIoInstance($ioInstance);
134 // Set template extensions
135 $templateInstance->setRawTemplateExtension($configInstance->getConfigEntry('raw_template_extension'));
136 $templateInstance->setCodeTemplateExtension($configInstance->getConfigEntry('menu_template_extension'));
138 // Absolute output path for compiled templates
139 $templateInstance->setCompileOutputPath($configInstance->getConfigEntry('base_path') . $configInstance->getConfigEntry('compile_output_path'));
141 // Set the menu instance
142 $templateInstance->setMenuInstance($menuInstance);
144 // Init a variable stacker
145 $stackerInstance = ObjectFactory::createObjectByConfiguredName('menu_stacker_class');
148 $templateInstance->setStackerInstance($stackerInstance);
150 // Return the prepared instance
151 return $templateInstance;
155 * Load a specified menu template into the engine
157 * @param $template The menu template we shall load which is
158 * located in 'menu' by default
161 public function loadMenuTemplate ($template) {
163 $this->setTemplateType($this->getConfigInstance()->getConfigEntry('menu_template_type'));
165 // Load the special template
166 $this->loadTemplate($template);
170 * Getter for current main node
172 * @return $currMainNode Current main node
174 public final function getCurrMainNode () {
175 return $this->curr['main_node'];
179 * Setter for current main node
181 * @param $element Element name to set as current main node
182 * @return $currMainNode Current main node
184 private final function setCurrMainNode ($element) {
185 $this->curr['main_node'] = (string) $element;
189 * Getter for main node array
191 * @return $mainNodes Array with valid main node names
193 public final function getMainNodes () {
194 return $this->mainNodes;
198 * Getter for sub node array
200 * @return $subNodes Array with valid sub node names
202 public final function getSubNodes () {
203 return $this->subNodes;
207 * Handles the start element of an XML resource
209 * @param $resource XML parser resource (currently ignored)
210 * @param $element The element we shall handle
211 * @param $attributes All attributes
213 * @throws InvalidXmlNodeException If an unknown/invalid XML node name was found
215 public function startElement ($resource, $element, array $attributes) {
216 // Initial method name which will never be called...
217 $methodName = 'initMenu';
219 // Make the element name lower-case
220 $element = strtolower($element);
222 // Is the element a main node?
223 //* DEBUG: */ echo "START: >".$element."<<br />\n";
224 if (in_array($element, $this->getMainNodes())) {
225 // Okay, main node found!
226 $methodName = 'start' . $this->convertToClassName($element);
229 $this->setCurrMainNode($element);
230 } elseif (in_array($element, $this->getSubNodes())) {
232 $methodName = 'start' . $this->convertToClassName($element);
233 } elseif ($element != 'menu') {
234 // Invalid node name found
235 throw new InvalidXmlNodeException(array($this, $element, $attributes), XmlParser::EXCEPTION_XML_NODE_UNKNOWN);
239 //* DEBUG: */ echo "call: ".$methodName."<br />\n";
240 call_user_func_array(array($this, $methodName), $attributes);
244 * Ends the main or sub node by sending out the gathered data
246 * @param $resource An XML resource pointer (currently ignored)
247 * @param $nodeName Name of the node we want to finish
249 * @throws XmlNodeMismatchException If current main node mismatches the closing one
251 public function endElement ($resource, $nodeName) {
252 // Make all lower-case
253 $nodeName = strtolower($nodeName);
255 // Does this match with current main node?
256 //* DEBUG: */ echo "END: >".$nodeName."<<br />\n";
257 if (($nodeName != $this->getCurrMainNode()) && (in_array($nodeName, $this->getMainNodes()))) {
259 throw new XmlNodeMismatchException (array($this, $nodeName, $this->getCurrMainNode()), XmlParser::EXCEPTION_XML_NODE_MISMATCH);
262 // Construct method name
263 $methodName = 'finish' . $this->convertToClassName($nodeName);
265 // Call the corresponding method
266 //* DEBUG: */ echo "call: ".$methodName."<br />\n";
267 call_user_func_array(array($this, $methodName), array());
273 * @param $resource XML parser resource (currently ignored)
274 * @param $characters Characters to handle
276 * @todo Find something useful with this!
278 public function characterHandler ($resource, $characters) {
279 // Trim all spaces away
280 $characters = trim($characters);
282 // Is this string empty?
283 if (empty($characters)) {
284 // Then skip it silently
288 // Assign the found characters to variable and use the last entry from
290 parent::assignVariable($this->getStackerInstance()->getNamed('current_node'), $characters);
294 * Handles the template dependency for given node
296 * @param $node The node we should load a dependency template
297 * @param $templateDependency A template to load to satisfy dependencies
300 private function handleTemplateDependency ($node, $templateDependency) {
301 // Is the template dependency set?
302 if ((!empty($templateDependency)) && (!isset($this->dependencyContent[$node]))) {
303 // Get a temporay menu template instance
304 $templateInstance = ObjectFactory::createObjectByConfiguredName('menu_template_class', array($this->getApplicationInstance(), $this->getMenuInstance()));
307 $templateInstance->loadMenuTemplate($templateDependency);
309 // Get an XmlParser instance
310 $templateInstance->renderXmlContent();
312 // Parse the template's content contents
313 $this->dependencyContent[$node] = $templateInstance->getRawTemplateData();
318 * Intializes the menu
320 * @param $templateDependency A template to load to satisfy dependencies
322 * @todo Add cache creation here
324 private function initMenu ($templateDependency = '') {
325 // Get web template engine
326 $this->setTemplateInstance(ObjectFactory::createObjectByConfiguredName('web_template_class', array($this->getApplicationInstance())));
328 // Handle the dependency template
329 $this->handleTemplateDependency('menu', $templateDependency);
331 // Push the node name on the stacker
332 $this->getStackerInstance()->pushNamed('current_node', 'menu');
336 * Starts the menu entries
338 * @param $templateDependency A template to load to satisfy dependencies
341 private function startEntryList () {
342 // Push the node name on the stacker
343 $this->getStackerInstance()->pushNamed('current_node', 'entry-list');
347 * Starts the menu block header
351 private function startBlockHeader () {
352 // Push the node name on the stacker
353 $this->getStackerInstance()->pushNamed('current_node', 'block-header');
357 * Starts the menu block footer
361 private function startBlockFooter () {
362 // Push the node name on the stacker
363 $this->getStackerInstance()->pushNamed('current_node', 'block-footer');
367 * Starts the menu property 'block-list'
371 private function startBlockList () {
372 // Push the node name on the stacker
373 $this->getStackerInstance()->pushNamed('current_node', 'block-list');
377 * Starts the menu property 'block'
381 private function startBlock () {
382 // Push the node name on the stacker
383 $this->getStackerInstance()->pushNamed('current_node', 'block');
387 * Starts the menu property 'title'
391 private function startTitle () {
392 // Push the node name on the stacker
393 $this->getStackerInstance()->pushNamed('current_node', 'title');
397 * Starts the menu property 'title-id'
401 private function startTitleId () {
402 // Push the node name on the stacker
403 $this->getStackerInstance()->pushNamed('current_node', 'title-id');
407 * Starts the menu property 'title-class'
411 private function startTitleClass () {
412 // Push the node name on the stacker
413 $this->getStackerInstance()->pushNamed('current_node', 'title-class');
417 * Starts the menu property 'title-text'
421 private function startTitleText () {
422 // Push the node name on the stacker
423 $this->getStackerInstance()->pushNamed('current_node', 'title-text');
427 * Starts the menu property 'entry'
431 private function startEntry () {
432 // Push the node name on the stacker
433 $this->getStackerInstance()->pushNamed('current_node', 'entry');
437 * Starts the menu property 'entry-id'
441 private function startEntryId () {
442 // Push the node name on the stacker
443 $this->getStackerInstance()->pushNamed('current_node', 'entry-id');
447 * Starts the menu property 'anchor'
451 private function startAnchor () {
452 // Push the node name on the stacker
453 $this->getStackerInstance()->pushNamed('current_node', 'anchor');
457 * Starts the menu property 'anchor-id'
461 private function startAnchorId () {
462 // Push the node name on the stacker
463 $this->getStackerInstance()->pushNamed('current_node', 'anchor-id');
467 * Starts the menu property 'anchor-text'
471 private function startAnchorText () {
472 // Push the node name on the stacker
473 $this->getStackerInstance()->pushNamed('current_node', 'anchor-text');
477 * Starts the menu property 'anchor-title'
481 private function startAnchorTitle () {
482 // Push the node name on the stacker
483 $this->getStackerInstance()->pushNamed('current_node', 'anchor-title');
487 * Starts the menu property 'anchor-href'
491 private function startAnchorHref () {
492 // Push the node name on the stacker
493 $this->getStackerInstance()->pushNamed('current_node', 'anchor-href');
497 * Starts the menu property 'footer-id'
501 private function startFooterId () {
502 // Push the node name on the stacker
503 $this->getStackerInstance()->pushNamed('current_node', 'footer-id');
507 * Starts the menu property 'footer-class'
511 private function startFooterClass () {
512 // Push the node name on the stacker
513 $this->getStackerInstance()->pushNamed('current_node', 'footer-class');
517 * Starts the menu property 'footer-text'
521 private function startFooterText () {
522 // Push the node name on the stacker
523 $this->getStackerInstance()->pushNamed('current_node', 'footer-text');
527 * Finishes the title node by added another template to the menu
531 private function finishTitle () {
532 // Pop the last entry
533 $this->getStackerInstance()->popNamed('current_node');
537 * Finishes the title-id node by
541 private function finishTitleId () {
542 // Pop the last entry
543 $this->getStackerInstance()->popNamed('current_node');
547 * Finishes the title-class node
551 private function finishTitleClass () {
552 // Pop the last entry
553 $this->getStackerInstance()->popNamed('current_node');
557 * Finishes the title-class node
561 private function finishTitleText () {
562 // Pop the last entry
563 $this->getStackerInstance()->popNamed('current_node');
567 * Finishes the footer-text node
571 private function finishFooterText () {
572 // Pop the last entry
573 $this->getStackerInstance()->popNamed('current_node');
577 * Finishes the footer-class node
581 private function finishFooterClass () {
582 // Pop the last entry
583 $this->getStackerInstance()->popNamed('current_node');
587 * Finishes the footer-id node
591 private function finishFooterId () {
592 // Pop the last entry
593 $this->getStackerInstance()->popNamed('current_node');
597 * Finishes the anchor-href node
601 private function finishAnchorHref () {
602 // Pop the last entry
603 $this->getStackerInstance()->popNamed('current_node');
607 * Finishes the anchor-title node
611 private function finishAnchorTitle () {
612 // Pop the last entry
613 $this->getStackerInstance()->popNamed('current_node');
617 * Finishes the anchor-text node
621 private function finishAnchorText () {
622 // Pop the last entry
623 $this->getStackerInstance()->popNamed('current_node');
627 * Finishes the anchor-id node
631 private function finishAnchorId () {
632 // Pop the last entry
633 $this->getStackerInstance()->popNamed('current_node');
637 * Finishes the anchor node
641 private function finishAnchor () {
642 // Pop the last entry
643 $this->getStackerInstance()->popNamed('current_node');
647 * Finishes the entry-id node
651 private function finishEntryId () {
652 // Pop the last entry
653 $this->getStackerInstance()->popNamed('current_node');
657 * Finishes the entry node
661 private function finishEntry () {
662 // Pop the last entry
663 $this->getStackerInstance()->popNamed('current_node');
667 * Finishes the block node
671 private function finishBlock () {
672 // Pop the last entry
673 $this->getStackerInstance()->popNamed('current_node');
677 * Finishes the block-list node
681 private function finishBlockList () {
682 // Pop the last entry
683 $this->getStackerInstance()->popNamed('current_node');
687 * Finishes the menu entries
691 private function finishEntryList () {
692 // Pop the last entry
693 $this->getStackerInstance()->popNamed('current_node');
697 * Finishes the menu block header
701 private function finishBlockHeader () {
702 // Pop the last entry
703 $this->getStackerInstance()->popNamed('current_node');
707 * Finishes the menu block footer
711 private function finishBlockFooter () {
712 // Pop the last entry
713 $this->getStackerInstance()->popNamed('current_node');
721 private function finishMenu () {
722 // Pop the last entry
723 $this->getStackerInstance()->popNamed('current_node');
727 * Getter for menu cache file (FQFN)
729 * @return $fqfn Full-qualified file name of the menu cache
731 public function getMenuCacheFqfn () {
732 // Get the FQFN ready
733 $fqfn = sprintf("%s%s%s/%s.%s",
734 $this->getConfigInstance()->getConfigEntry('base_path'),
735 $this->getGenericBasePath(),
738 $this->getMenuInstance()->getMenuName() . ':' .
739 $this->__toString() . ':' .
740 $this->getMenuInstance()->__toString()
742 $this->getMenuInstance()->getMenuType()