8ab109f8a99faccca72e8ce6daa9d5839c42f672
[core.git] / inc / classes / main / menu / class_BaseMenu.php
1 <?php
2 /**
3  * A general menu system class
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.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.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 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->getApplicationInstance(), $this));
45
46                 // Set it for later use
47                 $this->setTemplateInstance($templateInstance);
48
49                 // Load the menu template for all
50                 $this->getTemplateInstance()->loadMenuTemplate('generic_menu_entries');
51
52                 // Get the 'page' from request instance
53                 $page = $this->getApplicationInstance()->getRequestInstance()->getRequestElement('page');
54
55                 // Load the menu template for this page
56                 try {
57                         $this->getTemplateInstance()->loadMenuTemplate($page . '_menu_entries');
58                 } catch (FileIoException $e) {
59                         // @TODO Should we log it here? We should, because it will be silently ignored.
60                 }
61
62                 // Get the prepared content
63                 $menuContent = $this->getTemplateInstance()->getRawTemplateData();
64
65                 // Render it here
66                 $this->getTemplateInstance()->renderXmlContent($menuContent);
67                 die('!OK');
68         }
69
70         /**
71          * Transfers the rendered menu to a given templatex engine by assigning
72          * the rendered content with a template variable.
73          *
74          * @param       $templateInstance       An instance of a CompileableTemplate class
75          * @return      void
76          */
77         public function transferContentToTemplateEngine (CompileableTemplate $templateInstance) {
78                 $this->partialStub('templateInstance=' . $templateInstance->__toString());
79         }
80 }
81
82 // [EOF]
83 ?>