3 namespace CoreFramework\Menu;
5 // Import framework stuff
6 use CoreFramework\Bootstrap\FrameworkBootstrap;
7 use CoreFramework\Factory\ObjectFactory;
8 use CoreFramework\Object\BaseFrameworkSystem;
9 use CoreFramework\Registry\Registry;
10 use CoreFramework\Template\CompileableTemplate;
13 * A general menu system class
15 * @author Roland Haeder <webmaster@shipsimu.org>
17 * @copyright Copyright (c) 2007 - 2009 Roland Haeder, this is free software
18 * @license GNU GPL 3.0 or any newer version
19 * @link http://www.shipsimu.org
21 * This program is free software: you can redistribute it and/or modify
22 * it under the terms of the GNU General Public License as published by
23 * the Free Software Foundation, either version 3 of the License, or
24 * (at your option) any later version.
26 * This program is distributed in the hope that it will be useful,
27 * but WITHOUT ANY WARRANTY; without even the implied warranty of
28 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
29 * GNU General Public License for more details.
31 * You should have received a copy of the GNU General Public License
32 * along with this program. If not, see <http://www.gnu.org/licenses/>.
34 class BaseMenu extends BaseFrameworkSystem {
36 * Protected constructor
38 * @param $className Name of the class
41 protected function __construct ($className) {
42 // Call parent constructor
43 parent::__construct($className);
47 * Renders the menu by loading the base template and a menu-specific
52 public function renderMenu () {
53 // Initialize the menu system by preparing it's template instance
54 $templateInstance = ObjectFactory::createObjectByConfiguredName('menu_template_class', array($this));
56 // Set it for later use
57 $this->setTemplateInstance($templateInstance);
59 // Load the menu template for all
60 $templateInstance->loadMenuTemplate('generic_menu_entries');
62 // Get the 'command' from request instance
63 $command = FrameworkBootstrap::getRequestInstance()->getRequestElement('command');
65 // If page is empty, choose default
66 if (empty($command)) {
67 // Use default page as none has been specified
68 $command = $this->getConfigInstance()->getConfigEntry('default_' . Registry::getRegistry()->getInstance('app')->getAppShortName() . '_' . FrameworkBootstrap::getRequestTypeFromSystem() . '_command');
71 // Load the menu template for this page
73 $templateInstance->loadMenuTemplate($command . '_menu_entries');
74 } catch (FileNotFoundException $e) {
75 // Log exception @TODO Maybe to intrusive?
76 self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: Exception caught: ' . $e->__toString() . ', with message: ' . $e->getMessage());
79 // Render template data here
80 $templateInstance->renderXmlContent();
81 //exit(__METHOD__ . ':!OK');
85 * Transfers the rendered menu to a given template engine by assigning
86 * the rendered content with a template variable.
88 * @param $templateInstance An instance of a CompileableTemplate class
91 public function transferContentToTemplateEngine (CompileableTemplate $templateInstance) {
92 // Assign menu content to variable
93 $templateInstance->assignVariable('menu', $this->getTemplateInstance()->getMenuContent());
94 //* DEBUG */ $templateInstance->debugInstance();