inc/classes/main/template/menu/class_MenuTemplateEngine.php

   1 <?php
   2 /**
   3  * A Menu 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 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  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.
  15  *
  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.
  20  *
  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/>.
  23  */
  24 class MenuTemplateEngine extends BaseTemplateEngine implements CompileableTemplate {
  25         /**
  26          * Main nodes in the XML tree ('menu' is ignored)
  27          */
  28         private $mainNodes = array(
  29                 'block-list',
  30         );
  31
  32         /**
  33          * Sub nodes in the XML tree
  34          */
  35         private $subNodes = array(
  36                 'entry-list',
  37                 'entry',
  38                 'entry-id',
  39                 'entries-content',
  40                 'block-header',
  41                 'block-footer',
  42                 'footer-id',
  43                 'footer-class',
  44                 'footer-text',
  45                 'block',
  46                 'title',
  47                 'title-id',
  48                 'title-class',
  49                 'title-text',
  50                 'design',
  51                 'text',
  52                 'advert',
  53                 'anchor',
  54                 'anchor-id',
  55                 'anchor-text',
  56                 'anchor-title',
  57                 'anchor-href',
  58         );
  59
  60         /**
  61          * Menu instance
  62          */
  63         private $menuInstance = null;
  64
  65         /**
  66          * Current main node
  67          */
  68         private $curr = array();
  69
  70         /**
  71          * Content from dependency
  72          */
  73         private $dependencyContent = array();
  74
  75         /**
  76          * Protected constructor
  77          *
  78          * @return      void
  79          */
  80         protected function __construct () {
  81                 // Call parent constructor
  82                 parent::__construct(__CLASS__);
  83         }
  84
  85         /**
  86          * Creates an instance of the class TemplateEngine and prepares it for usage
  87          *
  88          * @param       $appInstance    A manageable application
  89          * @param       $menuInstance   A RenderableMenu instance
  90          * @return      $tplInstance    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
  96          *                                                                                      read-protected
  97          */
  98         public final static function createMenuTemplateEngine (ManageableApplication $appInstance, RenderableMenu $menuInstance) {
  99                 // Get a new instance
 100                 $tplInstance = new MenuTemplateEngine();
 101
 102                 // Get language and file I/O instances from application
 103                 $langInstance = $appInstance->getLanguageInstance();
 104                 $ioInstance = $appInstance->getFileIoInstance();
 105
 106                 // Determine base path
 107                 $templateBasePath = $tplInstance->getConfigInstance()->getConfigEntry('application_base_path') . $appInstance->getRequestInstance()->getRequestElement('app') . '/';
 108
 109                 // Is the base path valid?
 110                 if (empty($templateBasePath)) {
 111                         // Base path is empty
 112                         throw new BasePathIsEmptyException($tplInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
 113                 } elseif (!is_string($templateBasePath)) {
 114                         // Is not a string
 115                         throw new InvalidBasePathStringException(array($tplInstance, $templateBasePath), self::EXCEPTION_INVALID_STRING);
 116                 } elseif (!is_dir($templateBasePath)) {
 117                         // Is not a path
 118                         throw new BasePathIsNoDirectoryException(array($tplInstance, $templateBasePath), self::EXCEPTION_INVALID_PATH_NAME);
 119                 } elseif (!is_readable($templateBasePath)) {
 120                         // Is not readable
 121                         throw new BasePathReadProtectedException(array($tplInstance, $templateBasePath), self::EXCEPTION_READ_PROTECED_PATH);
 122                 }
 123
 124                 // Get configuration instance
 125                 $configInstance = FrameworkConfiguration::getInstance();
 126
 127                 // Set the base path
 128                 $tplInstance->setTemplateBasePath($templateBasePath);
 129
 130                 // Set the language and IO instances
 131                 $tplInstance->setLanguageInstance($langInstance);
 132                 $tplInstance->setFileIoInstance($ioInstance);
 133
 134                 // Set template extensions
 135                 $tplInstance->setRawTemplateExtension($configInstance->getConfigEntry('raw_template_extension'));
 136                 $tplInstance->setCodeTemplateExtension($configInstance->getConfigEntry('menu_template_extension'));
 137
 138                 // Absolute output path for compiled templates
 139                 $tplInstance->setCompileOutputPath($configInstance->getConfigEntry('base_path') . $configInstance->getConfigEntry('compile_output_path'));
 140
 141                 // Set the menu instance
 142                 $tplInstance->setMenuInstance($menuInstance);
 143
 144                 // Init a variable stacker
 145                 $stackerInstance = ObjectFactory::createObjectByConfiguredName('menu_stacker_class');
 146
 147                 // Set it
 148                 $tplInstance->setStackerInstance($stackerInstance);
 149
 150                 // Return the prepared instance
 151                 return $tplInstance;
 152         }
 153
 154         /**
 155          * Load a specified menu template into the engine
 156          *
 157          * @param       $template       The menu template we shall load which is
 158          *                                              located in 'menu' by default
 159          * @return      void
 160          */
 161         public function loadMenuTemplate ($template) {
 162                 // Set template type
 163                 $this->setTemplateType($this->getConfigInstance()->getConfigEntry('menu_template_type'));
 164
 165                 // Load the special template
 166                 $this->loadTemplate($template);
 167         }
 168
 169         /**
 170          * Getter for current main node
 171          *
 172          * @return      $currMainNode   Current main node
 173          */
 174         public final function getCurrMainNode () {
 175                 return $this->curr['main_node'];
 176         }
 177
 178         /**
 179          * Setter for current main node
 180          *
 181          * @param       $element                Element name to set as current main node
 182          * @return      $currMainNode   Current main node
 183          */
 184         private final function setCurrMainNode ($element) {
 185                 $this->curr['main_node'] = (string) $element;
 186         }
 187
 188         /**
 189          * Getter for main node array
 190          *
 191          * @return      $mainNodes      Array with valid main node names
 192          */
 193         public final function getMainNodes () {
 194                 return $this->mainNodes;
 195         }
 196
 197         /**
 198          * Getter for sub node array
 199          *
 200          * @return      $subNodes       Array with valid sub node names
 201          */
 202         public final function getSubNodes () {
 203                 return $this->subNodes;
 204         }
 205
 206         /**
 207          * Handles the start element of an XML resource
 208          *
 209          * @param       $resource               XML parser resource (currently ignored)
 210          * @param       $element                The element we shall handle
 211          * @param       $attributes             All attributes
 212          * @return      void
 213          * @throws      InvalidXmlNodeException         If an unknown/invalid XML node name was found
 214          */
 215         public function startElement ($resource, $element, array $attributes) {
 216                 // Initial method name which will never be called...
 217                 $methodName = 'initMenu';
 218
 219                 // Make the element name lower-case
 220                 $element = strtolower($element);
 221
 222                 // Is the element a main node?
 223                 //* DEBUG: */ echo "START: &gt;".$element."&lt;<br />\n";
 224                 if (in_array($element, $this->getMainNodes())) {
 225                         // Okay, main node found!
 226                         $methodName = 'start' . $this->convertToClassName($element);
 227
 228                         // Set it
 229                         $this->setCurrMainNode($element);
 230                 } elseif (in_array($element, $this->getSubNodes())) {
 231                         // Sub node found
 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);
 236                 }
 237
 238                 // Call method
 239                 //* DEBUG: */ echo "call: ".$methodName."<br />\n";
 240                 call_user_func_array(array($this, $methodName), $attributes);
 241         }
 242
 243         /**
 244          * Ends the main or sub node by sending out the gathered data
 245          *
 246          * @param       $resource       An XML resource pointer (currently ignored)
 247          * @param       $nodeName       Name of the node we want to finish
 248          * @return      void
 249          * @throws      XmlNodeMismatchException        If current main node mismatches the closing one
 250          */
 251         public function endElement ($resource, $nodeName) {
 252                 // Make all lower-case
 253                 $nodeName = strtolower($nodeName);
 254
 255                 // Does this match with current main node?
 256                 //* DEBUG: */ echo "END: &gt;".$nodeName."&lt;<br />\n";
 257                 if (($nodeName != $this->getCurrMainNode()) && (in_array($nodeName, $this->getMainNodes()))) {
 258                         // Did not match!
 259                         throw new XmlNodeMismatchException (array($this, $nodeName, $this->getCurrMainNode()), XmlParser::EXCEPTION_XML_NODE_MISMATCH);
 260                 } // END - if
 261
 262                 // Construct method name
 263                 $methodName = 'finish' . $this->convertToClassName($nodeName);
 264
 265                 // Call the corresponding method
 266                 //* DEBUG: */ echo "call: ".$methodName."<br />\n";
 267                 call_user_func_array(array($this, $methodName), array());
 268         }
 269
 270         /**
 271          * Currently not used
 272          *
 273          * @param       $resource               XML parser resource (currently ignored)
 274          * @param       $characters             Characters to handle
 275          * @return      void
 276          * @todo        Find something useful with this!
 277          */
 278         public function characterHandler ($resource, $characters) {
 279                 // Trim all spaces away
 280                 $characters = trim($characters);
 281
 282                 // Is this string empty?
 283                 if (empty($characters)) {
 284                         // Then skip it silently
 285                         return false;
 286                 } // END - if
 287
 288                 // Assign the found characters to variable and use the last entry from
 289                 // stack as the name
 290                 parent::assignVariable($this->getStackerInstance()->getNamed('current_node'), $characters);
 291         }
 292
 293         /**
 294          * Handles the template dependency for given node
 295          *
 296          * @param       $node   The node we should load a dependency template
 297          * @param       $templateDependency     A template to load to satisfy dependencies
 298          * @return      void
 299          */
 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()));
 305
 306                         // Then load it
 307                         $templateInstance->loadMenuTemplate($templateDependency);
 308
 309                         // Get an XmlParser instance
 310                         $templateInstance->renderXmlContent();
 311
 312                         // Parse the template's content contents
 313                         $this->dependencyContent[$node] = $templateInstance->getRawTemplateData();
 314                 } // END - if
 315         }
 316
 317         /**
 318          * Intializes the menu
 319          *
 320          * @param       $templateDependency     A template to load to satisfy dependencies
 321          * @return      void
 322          * @todo        Add cache creation here
 323          */
 324         private function initMenu ($templateDependency = '') {
 325                 // Get web template engine
 326                 $this->setTemplateInstance(ObjectFactory::createObjectByConfiguredName('web_template_class', array($this->getApplicationInstance())));
 327
 328                 // Handle the dependency template
 329                 $this->handleTemplateDependency('menu', $templateDependency);
 330
 331                 // Load the header template for this page
 332                 $this->getTemplateInstance()->loadCodeTemplate('menu_global_start');
 333
 334                 // Set the variable group to page
 335                 $this->setVariableGroup('menu');
 336
 337                 // Set its content in this template instance
 338                 $this->assignVariable('menu_start', $this->getTemplateInstance()->getRawTemplateData());
 339         }
 340
 341         /**
 342          * Finishes the menu
 343          *
 344          * @return      void
 345          */
 346         private function finishMenu () {
 347                 // Load the header template for this page
 348                 $this->getTemplateInstance()->loadCodeTemplate('menu_global_end');
 349
 350                 // Set the variable group to page
 351                 $this->setVariableGroup('menu');
 352
 353                 // Set its content in this template instance
 354                 $this->assignVariable('menu_end', $this->getTemplateInstance()->getRawTemplateData());
 355         }
 356
 357         /**
 358          * Starts the menu entries by loading a (maybe) provided template dependency
 359          *
 360          * @param       $templateDependency     A template to load to satisfy dependencies
 361          * @return      void
 362          */
 363         private function startEntryList ($templateDependency = '') {
 364                 // Handle the dependency template
 365                 $this->handleTemplateDependency('entries', $templateDependency);
 366
 367                 // Load the header template for this page
 368                 $this->getTemplateInstance()->loadCodeTemplate('menu_entries_start');
 369
 370                 // Set the variable group to page
 371                 $this->setVariableGroup('menu');
 372
 373                 // Set its content in this template instance
 374                 $this->assignVariable('entries_start', $this->getTemplateInstance()->getRawTemplateData());
 375         }
 376
 377         /**
 378          * Finishes the menu entries
 379          *
 380          * @return      void
 381          */
 382         private function finishEntryList () {
 383                 // Load the header template for this page
 384                 $this->getTemplateInstance()->loadCodeTemplate('menu_entries_end');
 385
 386                 // Set the variable group to page
 387                 $this->setVariableGroup('menu');
 388
 389                 // Set its content in this template instance
 390                 $this->assignVariable('entries_end', $this->getTemplateInstance()->getRawTemplateData());
 391         }
 392
 393         /**
 394          * Starts the menu block header
 395          *
 396          * @return      void
 397          */
 398         private function startBlockHeader () {
 399                 // Do we have a template instance?
 400                 if (is_null($this->getTemplateInstance())) {
 401                         // Init template instance for underlaying web templates
 402                         $templateInstance = ObjectFactory::createObjectByConfiguredName('web_template_class');
 403
 404                         // Set it in this template engine
 405                         $this->setTemplateInstance($templateInstance);
 406                 } // END - if
 407
 408                 // Load the header template for this page
 409                 $this->getTemplateInstance()->loadCodeTemplate('menu_header_start');
 410
 411                 // Set the variable group to page
 412                 $this->setVariableGroup('menu');
 413
 414                 // Set its content in this template instance
 415                 $this->assignVariable('header', $this->getTemplateInstance()->getRawTemplateData());
 416         }
 417
 418         /**
 419          * Finishes the menu block header
 420          *
 421          * @return      void
 422          */
 423         private function finishBlockHeader () {
 424                 // Load the header template for this page
 425                 $this->getTemplateInstance()->loadCodeTemplate('menu_header_end');
 426
 427                 // Set the variable group to page
 428                 $this->setVariableGroup('menu');
 429
 430                 // Set its content in this template instance
 431                 $this->assignVariable('header_end', $this->getTemplateInstance()->getRawTemplateData());
 432         }
 433
 434         /**
 435          * Starts the menu block footer
 436          *
 437          * @return      void
 438          */
 439         private function startBlockFooter () {
 440                 // Do we have a template instance?
 441                 if (is_null($this->getTemplateInstance())) {
 442                         // Init template instance for underlaying web templates
 443                         $templateInstance = ObjectFactory::createObjectByConfiguredName('web_template_class');
 444
 445                         // Set it in this template engine
 446                         $this->setTemplateInstance($templateInstance);
 447                 } // END - if
 448
 449                 // Load the footer template for this page
 450                 $this->getTemplateInstance()->loadCodeTemplate('menu_footer_start');
 451
 452                 // Set the variable group to page
 453                 $this->setVariableGroup('menu');
 454
 455                 // Set its content in this template instance
 456                 $this->assignVariable('footer', $this->getTemplateInstance()->getRawTemplateData());
 457         }
 458
 459         /**
 460          * Finishes the menu block footer
 461          *
 462          * @return      void
 463          */
 464         private function finishBlockFooter () {
 465                 // Load the footer template for this page
 466                 $this->getTemplateInstance()->loadCodeTemplate('menu_footer_end');
 467
 468                 // Set the variable group to page
 469                 $this->setVariableGroup('menu');
 470
 471                 // Set its content in this template instance
 472                 $this->assignVariable('footer_end', $this->getTemplateInstance()->getRawTemplateData());
 473         }
 474
 475         /**
 476          * Starts the menu property 'block-list'
 477          *
 478          * @return      void
 479          */
 480         private function startBlockList () {
 481                 // Push the node name on the stacker
 482                 $this->getStackerInstance()->pushNamed('current_node', 'block-list');
 483         }
 484
 485         /**
 486          * Starts the menu property 'block'
 487          *
 488          * @return      void
 489          */
 490         private function startBlock () {
 491                 // Push the node name on the stacker
 492                 $this->getStackerInstance()->pushNamed('current_node', 'block');
 493         }
 494
 495         /**
 496          * Starts the menu property 'title'
 497          *
 498          * @return      void
 499          */
 500         private function startTitle () {
 501                 // Push the node name on the stacker
 502                 $this->getStackerInstance()->pushNamed('current_node', 'title');
 503         }
 504
 505         /**
 506          * Starts the menu property 'title-id'
 507          *
 508          * @return      void
 509          */
 510         private function startTitleId () {
 511                 // Push the node name on the stacker
 512                 $this->getStackerInstance()->pushNamed('current_node', 'title-id');
 513         }
 514
 515         /**
 516          * Starts the menu property 'title-class'
 517          *
 518          * @return      void
 519          */
 520         private function startTitleClass () {
 521                 // Push the node name on the stacker
 522                 $this->getStackerInstance()->pushNamed('current_node', 'title-class');
 523         }
 524
 525         /**
 526          * Starts the menu property 'title-text'
 527          *
 528          * @return      void
 529          */
 530         private function startTitleText () {
 531                 // Push the node name on the stacker
 532                 $this->getStackerInstance()->pushNamed('current_node', 'title-text');
 533         }
 534
 535         /**
 536          * Starts the menu property 'entry'
 537          *
 538          * @return      void
 539          */
 540         private function startEntry () {
 541                 // Push the node name on the stacker
 542                 $this->getStackerInstance()->pushNamed('current_node', 'entry');
 543         }
 544
 545         /**
 546          * Starts the menu property 'entry-id'
 547          *
 548          * @return      void
 549          */
 550         private function startEntryId () {
 551                 // Push the node name on the stacker
 552                 $this->getStackerInstance()->pushNamed('current_node', 'entry-id');
 553         }
 554
 555         /**
 556          * Starts the menu property 'anchor'
 557          *
 558          * @return      void
 559          */
 560         private function startAnchor () {
 561                 // Push the node name on the stacker
 562                 $this->getStackerInstance()->pushNamed('current_node', 'anchor');
 563         }
 564
 565         /**
 566          * Starts the menu property 'anchor-id'
 567          *
 568          * @return      void
 569          */
 570         private function startAnchorId () {
 571                 // Push the node name on the stacker
 572                 $this->getStackerInstance()->pushNamed('current_node', 'anchor-id');
 573         }
 574
 575         /**
 576          * Starts the menu property 'anchor-text'
 577          *
 578          * @return      void
 579          */
 580         private function startAnchorText () {
 581                 // Push the node name on the stacker
 582                 $this->getStackerInstance()->pushNamed('current_node', 'anchor-text');
 583         }
 584
 585         /**
 586          * Starts the menu property 'anchor-title'
 587          *
 588          * @return      void
 589          */
 590         private function startAnchorTitle () {
 591                 // Push the node name on the stacker
 592                 $this->getStackerInstance()->pushNamed('current_node', 'anchor-title');
 593         }
 594
 595         /**
 596          * Starts the menu property 'anchor-href'
 597          *
 598          * @return      void
 599          */
 600         private function startAnchorHref () {
 601                 // Push the node name on the stacker
 602                 $this->getStackerInstance()->pushNamed('current_node', 'anchor-href');
 603         }
 604
 605         /**
 606          * Starts the menu property 'footer-id'
 607          *
 608          * @return      void
 609          */
 610         private function startFooterId () {
 611                 // Push the node name on the stacker
 612                 $this->getStackerInstance()->pushNamed('current_node', 'footer-id');
 613         }
 614
 615         /**
 616          * Starts the menu property 'footer-class'
 617          *
 618          * @return      void
 619          */
 620         private function startFooterClass () {
 621                 // Push the node name on the stacker
 622                 $this->getStackerInstance()->pushNamed('current_node', 'footer-class');
 623         }
 624
 625         /**
 626          * Starts the menu property 'footer-text'
 627          *
 628          * @return      void
 629          */
 630         private function startFooterText () {
 631                 // Push the node name on the stacker
 632                 $this->getStackerInstance()->pushNamed('current_node', 'footer-text');
 633         }
 634
 635         /**
 636          * Finishes the title node by added another template to the menu
 637          *
 638          * @return      void
 639          */
 640         private function finishTitle () {
 641                 // Pop the last entry
 642                 $this->getStackerInstance()->popNamed('current_node');
 643         }
 644
 645         /**
 646          * Finishes the title-id node by
 647          *
 648          * @return      void
 649          */
 650         private function finishTitleId () {
 651                 // Pop the last entry
 652                 $this->getStackerInstance()->popNamed('current_node');
 653         }
 654
 655         /**
 656          * Finishes the title-class node
 657          *
 658          * @return      void
 659          */
 660         private function finishTitleClass () {
 661                 // Pop the last entry
 662                 $this->getStackerInstance()->popNamed('current_node');
 663         }
 664
 665         /**
 666          * Finishes the title-class node
 667          *
 668          * @return      void
 669          */
 670         private function finishTitleText () {
 671                 // Pop the last entry
 672                 $this->getStackerInstance()->popNamed('current_node');
 673         }
 674
 675         /**
 676          * Finishes the footer-text node
 677          *
 678          * @return      void
 679          */
 680         private function finishFooterText () {
 681                 // Pop the last entry
 682                 $this->getStackerInstance()->popNamed('current_node');
 683         }
 684
 685         /**
 686          * Finishes the footer-class node
 687          *
 688          * @return      void
 689          */
 690         private function finishFooterClass () {
 691                 // Pop the last entry
 692                 $this->getStackerInstance()->popNamed('current_node');
 693         }
 694
 695         /**
 696          * Finishes the footer-id node
 697          *
 698          * @return      void
 699          */
 700         private function finishFooterId () {
 701                 // Pop the last entry
 702                 $this->getStackerInstance()->popNamed('current_node');
 703         }
 704
 705         /**
 706          * Finishes the anchor-href node
 707          *
 708          * @return      void
 709          */
 710         private function finishAnchorHref () {
 711                 // Pop the last entry
 712                 $this->getStackerInstance()->popNamed('current_node');
 713         }
 714
 715         /**
 716          * Finishes the anchor-title node
 717          *
 718          * @return      void
 719          */
 720         private function finishAnchorTitle () {
 721                 // Pop the last entry
 722                 $this->getStackerInstance()->popNamed('current_node');
 723         }
 724
 725         /**
 726          * Finishes the anchor-text node
 727          *
 728          * @return      void
 729          */
 730         private function finishAnchorText () {
 731                 // Pop the last entry
 732                 $this->getStackerInstance()->popNamed('current_node');
 733         }
 734
 735         /**
 736          * Finishes the anchor-id node
 737          *
 738          * @return      void
 739          */
 740         private function finishAnchorId () {
 741                 // Pop the last entry
 742                 $this->getStackerInstance()->popNamed('current_node');
 743         }
 744
 745         /**
 746          * Finishes the anchor node
 747          *
 748          * @return      void
 749          */
 750         private function finishAnchor () {
 751                 // Pop the last entry
 752                 $this->getStackerInstance()->popNamed('current_node');
 753         }
 754
 755         /**
 756          * Finishes the entry-id node
 757          *
 758          * @return      void
 759          */
 760         private function finishEntryId () {
 761                 // Pop the last entry
 762                 $this->getStackerInstance()->popNamed('current_node');
 763         }
 764
 765         /**
 766          * Finishes the entry node
 767          *
 768          * @return      void
 769          */
 770         private function finishEntry () {
 771                 // Pop the last entry
 772                 $this->getStackerInstance()->popNamed('current_node');
 773         }
 774
 775         /**
 776          * Finishes the block node
 777          *
 778          * @return      void
 779          */
 780         private function finishBlock () {
 781                 // Pop the last entry
 782                 $this->getStackerInstance()->popNamed('current_node');
 783         }
 784
 785         /**
 786          * Finishes the block-list node
 787          *
 788          * @return      void
 789          */
 790         private function finishBlockList () {
 791                 // Pop the last entry
 792                 $this->getStackerInstance()->popNamed('current_node');
 793         }
 794
 795         /**
 796          * Starts the menu text
 797          *
 798          * @return      void
 799          */
 800         private function startText () {
 801                 // Do we have a template instance?
 802                 if (is_null($this->getTemplateInstance())) {
 803                         // Init template instance for underlaying web templates
 804                         $templateInstance = ObjectFactory::createObjectByConfiguredName('web_template_class');
 805
 806                         // Set it in this template engine
 807                         $this->setTemplateInstance($templateInstance);
 808                 } // END - if
 809
 810                 // Load the text template for this page
 811                 $this->getTemplateInstance()->loadCodeTemplate('menu_text_start');
 812
 813                 // Set the variable group to page
 814                 $this->setVariableGroup('menu');
 815
 816                 // Set its content in this template instance
 817                 $this->assignVariable('text', $this->getTemplateInstance()->getRawTemplateData());
 818         }
 819
 820         /**
 821          * Finishes the menu text
 822          *
 823          * @return      void
 824          */
 825         private function finishText () {
 826                 // Load the text template for this page
 827                 $this->getTemplateInstance()->loadCodeTemplate('menu_text_end');
 828
 829                 // Set the variable group to page
 830                 $this->setVariableGroup('menu');
 831
 832                 // Set its content in this template instance
 833                 $this->assignVariable('text_end', $this->getTemplateInstance()->getRawTemplateData());
 834         }
 835
 836         /**
 837          * Getter for menu cache file (FQFN)
 838          *
 839          * @return      $fqfn   Full-qualified file name of the menu cache
 840          */
 841         public function getMenuCacheFqfn () {
 842                 // Get the FQFN ready
 843                 $fqfn = sprintf("%s%s%s/%s.%s",
 844                         $this->getConfigInstance()->getConfigEntry('base_path'),
 845                         $this->getGenericBasePath(),
 846                         'menus/_cache',
 847                         md5(
 848                                 $this->getMenuInstance()->getMenuName() . ':' .
 849                                 $this->__toString() . ':' .
 850                                 $this->getMenuInstance()->__toString()
 851                         ),
 852                         $this->getMenuInstance()->getMenuType()
 853                 );
 854
 855                 // Return it
 856                 return $fqfn;
 857         }
 858 }
 859
 860 // [EOF]
 861 ?>