Added very basic support (unfinished) for menu rendering

[core.git] / inc / classes / interfaces / menu / class_RenderableMenu.php

diff --git a/inc/classes/interfaces/menu/class_RenderableMenu.php b/inc/classes/interfaces/menu/class_RenderableMenu.php
index be12780baae00d3b09f5722d0f308d39cf03d968..8b0281c2e403184b3c0e834bb79d10cd2ebef389 100644 (file)
--- a/inc/classes/interfaces/menu/class_RenderableMenu.php
+++ b/inc/classes/interfaces/menu/class_RenderableMenu.php
@@ -2,11 +2,11 @@
 /**
  * An interface for renderable menus
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @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.ship-simu.org
+ * @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
@@ -22,7 +22,23 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 interface RenderableMenu extends FrameworkInterface {
+       /**
+        * Renders the menu by loading the base template and a menu-specific
+        * template.
+        *
+        * @return      void
+        */
+       function renderMenu ();
+
+       /**
+        * Transfers the rendered menu to a given template engine by assigning
+        * the rendered content with a template variable.
+        *
+        * @2param      $templateInstance       An instance of a CompileableTemplate class
+        * @return      void
+        */
+       function transferContentToTemplateEngine (CompileableTemplate $templateInstance);
 }
 
-//
+// [EOF]
 ?>