inc/main/interfaces/menu/class_RenderableMenu.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Menu;
   4
   5 // Import framework stuff
   6 use CoreFramework\Generic\FrameworkInterface;
   7
   8 /**
   9  * An interface for renderable menus
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  13  * @copyright   Copyright (c) 2007 - 2009 Roland Haeder, this is free software
  14  * @license             GNU GPL 3.0 or any newer version
  15  * @link                http://www.shipsimu.org
  16  *
  17  * This program is free software: you can redistribute it and/or modify
  18  * it under the terms of the GNU General Public License as published by
  19  * the Free Software Foundation, either version 3 of the License, or
  20  * (at your option) any later version.
  21  *
  22  * This program is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License
  28  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  29  */
  30 interface RenderableMenu extends FrameworkInterface {
  31         /**
  32          * Renders the menu by loading the base template and a menu-specific
  33          * template.
  34          *
  35          * @return      void
  36          */
  37         function renderMenu ();
  38
  39         /**
  40          * Transfers the rendered menu to a given template engine by assigning
  41          * the rendered content with a template variable.
  42          *
  43          * @2param      $templateInstance       An instance of a CompileableTemplate class
  44          * @return      void
  45          */
  46         function transferContentToTemplateEngine (CompileableTemplate $templateInstance);
  47
  48 }