inc/main/classes/menu/class_BaseMenu.php

   1 <?php
   2 /**
   3  * A general menu system class
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007 - 2009 Roland Haeder, this is free software
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.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 BaseMenu extends BaseFrameworkSystem {
  25         /**
  26          * Protected constructor
  27          *
  28          * @param       $className      Name of the class
  29          * @return      void
  30          */
  31         protected function __construct ($className) {
  32                 // Call parent constructor
  33                 parent::__construct($className);
  34         }
  35
  36         /**
  37          * Renders the menu by loading the base template and a menu-specific
  38          * template.
  39          *
  40          * @return      void
  41          */
  42         public function renderMenu () {
  43                 // Initialize the menu system by preparing it's template instance
  44                 $templateInstance = ObjectFactory::createObjectByConfiguredName('menu_template_class', array($this));
  45
  46                 // Set it for later use
  47                 $this->setTemplateInstance($templateInstance);
  48
  49                 // Load the menu template for all
  50                 $templateInstance->loadMenuTemplate('generic_menu_entries');
  51
  52                 // Get the 'command' from request instance
  53                 $command = $this->getApplicationInstance()->getRequestInstance()->getRequestElement('command');
  54
  55                 // If page is empty, choose default
  56                 if (empty($command)) {
  57                         // Use default page as none has been specified
  58                         $command = $this->getConfigInstance()->getConfigEntry('default_' . $this->getApplicationInstance()->getAppShortName() . '_' . self::getResponseTypeFromSystem() . '_command');
  59                 } // END - if
  60
  61                 // Load the menu template for this page
  62                 try {
  63                         $templateInstance->loadMenuTemplate($command . '_menu_entries');
  64                 } catch (FileNotFoundException $e) {
  65                         // Log exception @TODO Maybe to intrusive?
  66                         self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: Exception caught: ' . $e->__toString() . ', with message: ' . $e->getMessage());
  67                 }
  68
  69                 // Render template data here
  70                 $templateInstance->renderXmlContent();
  71                 //exit(__METHOD__ . ':!OK');
  72         }
  73
  74         /**
  75          * Transfers the rendered menu to a given template engine by assigning
  76          * the rendered content with a template variable.
  77          *
  78          * @param       $templateInstance       An instance of a CompileableTemplate class
  79          * @return      void
  80          */
  81         public function transferContentToTemplateEngine (CompileableTemplate $templateInstance) {
  82                 // Assign menu content to variable
  83                 $templateInstance->assignVariable('menu', $this->getTemplateInstance()->getMenuContent());
  84                 //* DEBUG */ $templateInstance->debugInstance();
  85         }
  86 }
  87
  88 // [EOF]
  89 ?>