ship-simu/inc/classes/interfaces/template/class_CompileableTemplate.php

   1 <?php
   2 /**
   3  * An interface for template engines
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0
   7  * @copyright   Copyright(c) 2007, 2008 Roland Haeder, this is free software
   8  * @license             GNU GPL 3.0 or any newer version
   9  *
  10  * This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  */
  23 interface CompileableTemplate extends FrameworkInterface {
  24         /**
  25          * Assign variables for templates
  26          *
  27          * @param               $var            The "variable" we want to assign
  28          * @param               $value  The value we want to store in the variable
  29          * @return      void
  30          */
  31         function assignVariable ($var, $value);
  32
  33         /**
  34          * Assign a configuration variables for templates
  35          *
  36          * @param               $var            The configuration "variable" we want to assign
  37          * @param               $value  The value we want to store in the variable
  38          * @return      void
  39          */
  40         function assignConfigVariable ($var, $value);
  41
  42         /**
  43          * Load a specified web template into the engine
  44          *
  45          * @param               $template               The web template we shall load which is
  46          *                                              located in "html" by default
  47          * @return      void
  48          */
  49         function loadWebTemplate ($template);
  50
  51         /**
  52          * Load a specified code template into the engine for later compilation
  53          * with other code/web/email templates.
  54          *
  55          * @param               $template               The code template we shall load which is
  56          *                                              located in "html" by default
  57          * @return      void
  58          */
  59         function loadCodeTemplate ($template);
  60
  61         /**
  62          * Load a specified email template into the engine
  63          *
  64          * @param               $template               The email template we shall load which is
  65          *                                              located in "emails" by default
  66          * @return      void
  67          */
  68         function loadEmailTemplate ($template);
  69
  70         /**
  71          * Compile all variables by inserting their respective values
  72          *
  73          * @return      void
  74          */
  75         function compileVariables ();
  76
  77
  78         /**
  79          * Compile all required code/web/email-templates into the current one
  80          *
  81          * @return      void
  82          */
  83         function compileTemplate ();
  84
  85         /**
  86          * Output the compiled template to the outside world. In case of web
  87          * templates this would be vaild (X)HTML code. And in case of email
  88          * templates this would store a prepared email body inside the template
  89          * engine.
  90          *
  91          * @return      void
  92          */
  93         function output ();
  94 } // END - class
  95
  96 // [EOF]
  97 ?>