3 * An interface for template engines
5 * @author Roland Haeder <webmaster@mxchange.org>
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.mxchange.org
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.
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.
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/>.
24 interface CompileableTemplate extends FrameworkInterface {
26 * Assign variables for templates
28 * @param $var The "variable" we want to assign
29 * @param $value The value we want to store in the variable
32 function assignVariable ($var, $value);
35 * Assign a configuration variables for templates
37 * @param $var The configuration "variable" we want to assign
38 * @param $value The value we want to store in the variable
41 function assignConfigVariable ($var, $value);
44 * Load a specified web template into the engine
46 * @param $template The web template we shall load which is
47 * located in "html" by default
50 function loadWebTemplate ($template);
53 * Load a specified code template into the engine for later compilation
54 * with other code/web/email templates.
56 * @param $template The code template we shall load which is
57 * located in "html" by default
60 function loadCodeTemplate ($template);
63 * Load a specified email template into the engine
65 * @param $template The email template we shall load which is
66 * located in "emails" by default
69 function loadEmailTemplate ($template);
72 * Compile all variables by inserting their respective values
76 function compileVariables ();
80 * Compile all required code/web/email-templates into the current one
84 function compileTemplate ();
87 * Output the compiled template to the outside world. In case of web
88 * templates this would be vaild (X)HTML code. And in case of email
89 * templates this would store a prepared email body inside the template