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