<?php
// Own namespace
namespace CoreFramework\Menu;

// Import framework stuff
use CoreFramework\Bootstrap\FrameworkBootstrap;
use CoreFramework\Factory\ObjectFactory;
use CoreFramework\Filesystem\FileNotFoundException;
use CoreFramework\Object\BaseFrameworkSystem;
use CoreFramework\Registry\Registry;
use CoreFramework\Template\CompileableTemplate;

/**
 * A general menu system class
 *
 * @author		Roland Haeder <webmaster@shipsimu.org>
 * @version		0.0.0
 * @copyright	Copyright (c) 2007 - 2009 Roland Haeder, this is free software
 * @license		GNU GPL 3.0 or any newer version
 * @link		http://www.shipsimu.org
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
class BaseMenu extends BaseFrameworkSystem {
	/**
	 * Protected constructor
	 *
	 * @param	$className	Name of the class
	 * @return	void
	 */
	protected function __construct ($className) {
		// Call parent constructor
		parent::__construct($className);
	}

	/**
	 * Renders the menu by loading the base template and a menu-specific
	 * template.
	 *
	 * @return	void
	 */
	public function renderMenu () {
		// Initialize the menu system by preparing it's template instance
		$templateInstance = ObjectFactory::createObjectByConfiguredName('menu_template_class', array($this));

		// Set it for later use
		$this->setTemplateInstance($templateInstance);

		// Load the menu template for all
		$templateInstance->loadMenuTemplate('generic_menu_entries');

		// Get the 'command' from request instance
		$command = FrameworkBootstrap::getRequestInstance()->getRequestElement('command');

		// If page is empty, choose default
		if (empty($command)) {
			// Use default page as none has been specified
			$command = $this->getConfigInstance()->getConfigEntry('default_' . Registry::getRegistry()->getInstance('app')->getAppShortName() . '_' . FrameworkBootstrap::getRequestTypeFromSystem() . '_command');
		} // END - if

		// Load the menu template for this page
		try {
			$templateInstance->loadMenuTemplate($command . '_menu_entries');
		} catch (FileNotFoundException $e) {
			// Log exception @TODO Maybe to intrusive?
			self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']: Exception caught: ' . $e->__toString() . ', with message: ' . $e->getMessage());
		}

		// Render template data here
		$templateInstance->renderXmlContent();
		//exit(__METHOD__ . ':!OK');
	}

	/**
	 * Transfers the rendered menu to a given template engine by assigning
	 * the rendered content with a template variable.
	 *
	 * @param	$templateInstance	An instance of a CompileableTemplate class
	 * @return	void
	 */
	public function transferContentToTemplateEngine (CompileableTemplate $templateInstance) {
		// Assign menu content to variable
		$templateInstance->assignVariable('menu', $this->getTemplateInstance()->getMenuContent());
		//* DEBUG */ $templateInstance->debugInstance();
	}

}