generated frominherelab/php-pkg-template
- Notifications
You must be signed in to change notification settings - Fork2
⚡️ Simple and fastly template engine for PHP.
License
NotificationsYou must be signed in to change notification settings
phppkg/easytpl
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
⚡️ Simple and fastly template engine for PHP.
- It's simple, lightweight and fastly.
- No learning costs, syntax like PHP template
- It is simply processed and converted into native PHP syntax
- Compatible with PHP native syntax
- support simple echo print syntax. eg:
{{ var }}{{= $var }}{{ $var }}{{ echo $var }}- allow ignore prefix
$, will auto append on compile.
- allow ignore prefix
- support chained access array value. eg:
{{ $arr.0 }}{{ $map.name }}{{ $map.user.name }} - support all control syntax. such as
if,elseif,else;foreach;for;switch - support php builtin function as filters. eg:
{{ $var | ucfirst }}{{ date('Y-m-d') }} - More secure, the output will be processed automatically through
htmlspecialcharsby default- You can set to disable output filtering or manually use the
rawfilter
- You can set to disable output filtering or manually use the
- support add custom filters.
- default builtin filters:
upperlowernl
- default builtin filters:
- support add custom directive.
EasyTemplatebuilt in supportlayoutincludecontentsExtendTemplatebuilt in supportextendsblockendblock
- support comments in templates. eg:
{{# comments ... #}}
- Required PHP 8.0+
composer
composer require phppkg/easytpl
usePhpPkg\EasyTpl\EasyTemplate;$tplCode = <<<'CODE'My name is {{ $name | strtoupper }},My develop tags:{{ foreach($tags as $tag) }}- {{ $tag }}{{ endforeach }}CODE;$t =newEasyTemplate();$str =$t->renderString($tplCode, ['name' =>'inhere','tags' => ['php','go','java'],]);echo$str;
Output:
My name is INHERE,My develop tags:- php- go- javaThe syntax is the same as the PHP native template, and the special syntax added is just to make it more convenient to use.
EasyTemplateenables output filtering by default, which can be used to render view templates.TextTemplateturns off output filtering and is mainly used for text processing, code generation, etc.
usePhpPkg\EasyTpl\EasyTemplate;$t = EasyTemplate::new(['tplDir' =>'path/to/templates','allowExt' => ['.php','.tpl'],]);// do something ...
more settings：
/** @var PhpPkg\EasyTpl\EasyTemplate $t */$t->disableEchoFilter();$t->addFilter($name,$filterFn);$t->addFilters([]);$t->addDirective($name,$handler);
The following statements are the same, can be used to print out variable values
{{ name }}{{$name }}{{=$name }}{{echo$name }}More:
{{$name ?:'inhere' }}{{$age >20 ?'20+' :'<= 20' }}By default, the output result will be automatically processed through
htmlspecialchars,unless disabled or manually usedrawfilter
- Set to disable output filtering
$t->disableEchoFilter() - Disable output filtering in the template
{{ $name | raw }}
Can use. to quick access array value.
$arr = ['val0','subKey' =>'val1',];
Use in template:
First value is: {{$arr.0 }}// val0'subKey' value is: {{$arr.subKey }}// val1onlyif:
{{if ($name !=='') }}hi, my name is {{$name }}{{ endif }}if else:
hi, my name is {{$name }}age is {{$age }},and{{if ($age >=20) }} age >=20.{{ else }} age <20.{{ endif }}if...elseif...else:
hi, my name is {{$name }}age is {{$age }},and{{if ($age >=50) }} age >=50.{{elseif ($age >=20) }} age >=20.{{ else }} age <20.{{ endif }}foreach:
tags:{{foreach($tagsas$tag) }}- {{$tag }}{{ endforeach }}with keys:
tags:{{foreach($tagsas$index =>$tag) }}{{$index }}. {{$tag }}{{ endforeach }}The contents wrapped with{{ and}} will be ignored as comments.
{{# comments ... #}}{{ $name }} // inheremulti lines:
{{#this comments block#}}{{ $name }} // inhereDefault built-in filters:
upper- equalsstrtoupperlower- equalsstrtolowernl- append newline\n
You can use the filters in any of your templates.
Regular usage:
{{'inhere' | ucfirst }}// Inhere{{'inhere' | upper }}// INHEREChained usage:
{{'inhere' | ucfirst | substr:0,2 }}// In{{'1999-12-31' | date:'Y/m/d' }}// 1999/12/31Passing non-static values:
{{$name | ucfirst | substr:0,1 }}{{$user['name'] | ucfirst | substr:0,1 }}{{$userObj->name | ucfirst | substr:0,1 }}{{$userObj->getName() | ucfirst | substr:0,1 }}Passing variables as filter parameters:
{{$suffix ='￥';}}{{'12.75' | add_suffix:$suffix }}// 12.75￥usePhpPkg\EasyTpl\EasyTemplate;$tpl = EasyTemplate::new();// use php built function$tpl->addFilter('upper','strtoupper');// add more$tpl->addFilters(['last3chars' =>function (string$str):string {returnsubstr($str, -3); },]);
Use in template:
{{$name ='inhere';}}{{$name | upper }}// INHERE{{$name | last3chars }}// ere{{$name | last3chars | upper }}// EREYou can use the directives implement some special logic.
EasyTemplatebuilt in support:layoutincludecontents
$tpl = EasyTemplate::new();$tpl->addDirective('include',function (string$body,string$name) {/** will call {@see EasyTemplate::include()} */return'$this->include' .$body; });
- page template
home01.tpl
{{layout('layouts/layout01.tpl') }}on home: block body;Use in template
{{include('part/header.tpl', ['title' =>'My world']) }}New directives:
extendsextends a layout template file.- syntax:
{{ extends('layouts/main.tpl') }}
- syntax:
blockdefine a new template block start.- syntax:
{{ block 'header' }}
- syntax:
endblockmark a block end.- syntax:
{{ endblock }}
- syntax:
usePhpPkg\EasyTpl\ExtendTemplate;$et =newExtendTemplate();$et->display('home/index.tpl');
- on layout file:
layouts/main.tpl
{{ block'header' }}header contents in layout main.{{ endblock }}{{ block'body' }}body contents in layout main.{{ endblock }}{{ block'footer' }}footer contents in layout main.{{ endblock }}- on page file:
home/index.tpl
{{extends('layouts/main.tpl') }}{{ block'body' }}body contents in home index.{{ endblock }}Rendered results
header contents in layout main.body contents in home index.footer contents in layout main.About
⚡️ Simple and fastly template engine for PHP.