mezon/template-engine

Small template engine for your projects

1.0.8 2022-07-18 11:52 UTC

Requires

• php: >=7.2.0
• mezon/functional: ^1.0

Requires (Dev)

• infection/infection: ^0.21.5
• phpunit/php-token-stream: 3.1.2
• phpunit/phpunit: ^8.5
• vimeo/psalm: ^4.2

MIT

• Dodonov Alexey

README

Intro

Template engine provides template compilation routine with variables, loops and other programming abstractions.

Loading resources

Mezon has a simple storage wich stores CSS and JS files. When page is rendered, template engine accessing it and fetching files to put in the 'head' tag of the rendered page.

Storage is globally accessed. So any componen can add it's own resources to the page.

It can be done in this way:

$TemplateResources = new TemplateResources(); // getting access to the global storage

$TemplateResources->add_css_file( './res/test.css' ); // additing CSS file
$TemplateResources->add_js_file( './include/js/test.js' ); // additing JS file

$TemplateResources->add_css_files( 
    [ './res/test1.css' , './res/test2.css' ]
); // additing CSS files
$TemplateResources->add_js_files(
    [ './include/js/test1.js' , './include/js/test2.js' ]
); // additing JS files

Resource storage is quite intilligent so you can't add many files with the same paths.

$TemplateResources = new TemplateResources(); // getting access to the global storage

$TemplateResources->add_css_file( './res/test.css' ); // additing CSS file
$TemplateResources->add_css_file( './res/test.css' ); // no file will be added

But this way of additing resources is quite low level and it may be inconvinient for large number of resource files. So we have created assets. The documentation about it can be read here

Page compilation

TemplateEngine class provides content compilation routine. This function is called TemplateEngine::print_record( $String , $Data ) wich replaces all variables {variable-name} with values from $Data.

// outputs "v1 v2"
print( TemplateEngine::print_record( 
    '{var1} {var2}' , [ 'var1' => 'v1' , 'var2' => 'v2' ] 
) );

// or object
$Object = new stdClass();
$Object->var1 = 'v1';
$Object->var2 = 'v2';

// outputs "v1 v2"
print( TemplateEngine::print_record( 
    '{var1} {var2}' , $Object 
) );

// $Data may contain nested arrays or objects
// outputs "v1 v2 v3"
print( TemplateEngine::print_record( 
    '{var1} {var2} {var3}' , [ $Object , [ 'var3' => 'v3' ] ]
) );

Template variables

You can use template variables bounded by '{' and '}' symbols.

For example:

Extended page compilation

You may also use loopes in your templates.

For example:

$Engine = new TemplateEngine();
$Engine->set_page_var( 'var1' , 'value1' );
$Engine->set_page_var( 'var2' , 'value2' );

$Content = '{var1} & {var2}';
print( $Engine->compile_page_vars( $Content ) ); // outputs "value1 value2"

And the output will be:

row : 1<br>
row : 2<br>
row : Last<br>