stupid_template_engine.php

The implementation of the Stupid Template Engine.

Summary

stupid_template_engine.php	The implementation of the Stupid Template Engine.
License	This file is licensed under the MIT/X11 License.
ste	Everything in this file is in this namespace.
Functions
precompile	Precompiling STE T/PL templates.
parse	Parsing a STE T/PL template.
transcompile	Transcompiles an abstract syntax tree to PHP.
Constants
Template modes
StorageAccess	An interface.
Functions
load	Loading a template.
save	Saves a template.
FilesystemStorageAccess	The default StorageAccess implementation for loading / saving templates into a directory structure.
Functions
__construct
STECore	The Core of STE
Variables
Public variables
Functions
__construct
register_tag	Register a custom tag.
call_tag	Calling a custom tag (builtin ones can not be called)
exectemplate	Executes a template and returns the result.
get_var_reference	Get a reference to a template variable using a variable name.
set_var_by_name	Set a template variable by its name.
get_var_by_name	Get a template variable by its name.
load	Load a template and return its result (blocks not included, use exectemplate for this).
evalbool	Test, if a text represents false (an empty / only whitespace text) or true (everything else).

License

This file is licensed under the MIT/X11 License. See COPYING for more details.

ste

Everything in this file is in this namespace.

Summary

Functions
precompile	Precompiling STE T/PL templates.
parse	Parsing a STE T/PL template.
transcompile	Transcompiles an abstract syntax tree to PHP.
Constants
Template modes

Functions

precompile

function precompile( $code )

Precompiling STE T/PL templates. You only need this function, if you want to manually transcompile a template.

Parameters

$code

The input code

Returns

The precompiled code.

parse

function parse( $code,
$tpl )

Parsing a STE T/PL template. You only need this function, if you want to manually transcompile a template.

Parameters

$code	The STE T/PL code.
$tpl	The name of the template.

Returns

An abstract syntax tree, which can be used with transcompile.

transcompile

function transcompile( $ast ) /* Transcompile and add some boilerplate code. */

Transcompiles an abstract syntax tree to PHP. You only need this function, if you want to manually transcompile a template.

Parameters

$ast	The abstract syntax tree to transcompile.

Returns

PHP code. The PHP code is an anonymous function expecting a STECore instance as its parameter and returns a string (everything that was not pached into a section).

Constants

Template modes

MODE_SOURCE	The Templates source
MODE_TRANSCOMPILED	The transcompiled template

StorageAccess

An interface. A StorageAccess implementation is used to access the templates from any storage. This means, that you are not limited to store the Templates inside directories, you can also use a database or something else.

Summary

Functions
load	Loading a template.
save	Saves a template.

Functions

load

public function load( $tpl,
& $mode )

Loading a template.

Parameters

$tpl	The name of the template.
&$mode	Which mode is preferred? One of the <Template modes>. If <MODE_SOURCE>, the raw sourcecode is expected, if <MODE_TRANSCOMPILED> the transcompiled template as a callable function (expecting an STECore instance as first parameter) is expected. If the transcompiled version is not available or older than the source, you can set this parameter to <MODE_SOURCE> and return the source.

Returns

Either the sourcecode or a callable function (first, and only parameter: an STECore instance).

save

public function save( $tpl,
$data,
$mode )

Saves a template.

Parameters

$tpl -The name of the template. $data - The data to be saved. $mode - A <Template mode> constant.

FilesystemStorageAccess

The default StorageAccess implementation for loading / saving templates into a directory structure.

Summary

Functions
__construct

Functions

__construct

public function __construct( $src,
$transc )

Parameters

$src	The directory with the sources (Writing permissions are not mandatory, because STE does not save template sources).
$transc	The directory with the transcompiled templates (the PHP instance / the HTTP Server needs writing permissions to this directory).

STECore

The Core of STE

Summary

Variables
Public variables
Functions
__construct
register_tag	Register a custom tag.
call_tag	Calling a custom tag (builtin ones can not be called)
exectemplate	Executes a template and returns the result.
get_var_reference	Get a reference to a template variable using a variable name.
set_var_by_name	Set a template variable by its name.
get_var_by_name	Get a template variable by its name.
load	Load a template and return its result (blocks not included, use exectemplate for this).
evalbool	Test, if a text represents false (an empty / only whitespace text) or true (everything else).

Variables

Public variables

$blocks	Associative array of blocks (see the language definition).
$blockorder	The order of the blocks (an array)
$vars	Associative array of all template variables. Use this to pass data to your templates.

Functions

__construct

public function __construct( $storage_access )

Parameters

$storage_access

An Instance of a StorageAccess implementation.

register_tag

public function register_tag( $name,
$callback )

Parameters

$name	The name of the tag.
$callback	A callable function (This must tage three parameters: The STECore instance, an associative array of parameters, and a function representing the tags content(This expects the STECore instance as its only parameter and returns its text result, i.e to get the text, you neeed to call this function with the STECore instance as a parameter)).

call_tag

public function call_tag( $name,
$params,
$sub )

Calling a custom tag (builtin ones can not be called)

Parameters

$name	The Tag’s name
$params	Associative array of parameters
$sub	A callable function (expecting an STECore instance as it’s parameter) that represents the tag’s content.

Returns

The output of the tag.

exectemplate

public function exectemplate( $tpl )

Executes a template and returns the result. The huge difference to load is that this function will also output all blocks.

Parameters

$tpl	The name of the template to execute.

Returns

The output of the template.

get_var_reference

public function &get_var_reference( $name,
$create_if_not_exist )

Get a reference to a template variable using a variable name. This can be used,if your custom tag takes a variable name as a parameter.

Parameters

$name	The variables name.
$create_if_not_exist	Should the variable be created, if it does not exist? Otherwise NULL will be returned, if the variable does not exist.

Returns

A Reference to the variable.

set_var_by_name

public function set_var_by_name( $name,
$val )

Set a template variable by its name. This can be used,if your custom tag takes a variable name as a parameter.

Parameters

$name	The variables name.
$val	The new value.

get_var_by_name

public function get_var_by_name( $name )

Get a template variable by its name. This can be used,if your custom tag takes a variable name as a parameter.

Parameters

$name

The variables name.

Returns

The variables value.

load

public function load( $tpl,
$quiet = False )

Load a template and return its result (blocks not included, use exectemplate for this).

Parameters

$tpl	The name of the template to be loaded.
$quiet	If true, do not output anything and do notmodify the blocks. This can be useful to load custom tags that are programmed in STE T/PL. Default: false.

Returns

The result of the template (if $quiet == false).

evalbool

public function evalbool( $txt )

Test, if a text represents false (an empty / only whitespace text) or true (everything else).

Parameters

$txt	The text to test.

Returns

true/false.