3 * A general menu system class
5 * @author Roland Haeder <webmaster@shipsimu.org>
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
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 BaseMenu extends BaseFrameworkSystem {
26 * Protected constructor
28 * @param $className Name of the class
31 protected function __construct ($className) {
32 // Call parent constructor
33 parent::__construct($className);
37 * Renders the menu by loading the base template and a menu-specific
42 public function renderMenu () {
43 // Initialize the menu system by preparing it's template instance
44 $templateInstance = ObjectFactory::createObjectByConfiguredName('menu_template_class', array($this));
46 // Set it for later use
47 $this->setTemplateInstance($templateInstance);
49 // Load the menu template for all
50 $templateInstance->loadMenuTemplate('generic_menu_entries');
52 // Get the 'page' from request instance
53 $page = $this->getApplicationInstance()->getRequestInstance()->getRequestElement('page');
55 // If page is empty, choose default
57 // Use default page as none has been specified
58 $page = $this->getConfigInstance()->getConfigEntry('default_' . $this->getApplicationInstance()->getAppShortName() . '_' . self::getResponseTypeFromSystem() . '_command');
61 // Load the menu template for this page
63 $templateInstance->loadMenuTemplate($page . '_menu_entries');
64 } catch (FileIoException $e) {
65 // Log exception @TODO Maybe to intrusive?
66 self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: Exception caught: ' . $e->__toString() . ', with message: ' . $e->getMessage());
69 // Render template data here
70 $templateInstance->renderXmlContent();
71 //exit(__METHOD__ . ':!OK');
75 * Transfers the rendered menu to a given template engine by assigning
76 * the rendered content with a template variable.
78 * @param $templateInstance An instance of a CompileableTemplate class
81 public function transferContentToTemplateEngine (CompileableTemplate $templateInstance) {
82 // Assign menu content to variable
83 $templateInstance->assignVariable('menu_content', $this->getTemplateInstance()->getMenuContent());
84 //* DEBUG */ $templateInstance->debugInstance();