dd23251492fdc7ec3eed3a2824c774c0fde684e0
[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()));
45
46                 // Set it for later use
47                 $this->setTemplateInstance($templateInstance);
48
49                 // Something is not yet ready
50                 $this->partialStub('Please implement this method.');
51         }
52
53         /**
54          * Transfers the rendered menu to a given templatex engine by assigning
55          * the rendered content with a template variable.
56          *
57          * @2param      $templateInstance       An instance of a CompileableTemplate class
58          * @return      void
59          */
60         public function transferContentToTemplateEngine (CompileableTemplate $templateInstance) {
61                 $this->partialStub('templateInstance=' . $templateInstance->__toString());
62         }
63 }
64
65 // [EOF]
66 ?>