README

HTML Templater for PHP.

Lightweight, simple but powerful templater for rendering HTML templates in PHP.

I believe that you'd like to

keep your HTML clean and simple and
bring logic to PHP (PHP itself is a templater, isn't it?), not to HTML.

Table of Contents
Requirements
Installation
Getting Started

Requirements

PHP 7.4 and later.

Installation

composer require hokoo/templater

Getting Started

Here are some examples of how to use the templater.

Simple using

use iTRON\Templater\Templater;
$templater = new Templater();

$html = <<<TEMPLATE
<div class="popup %s" data-popup="%s">
    
    <div class="title">
        %s
    </div>
    
    <div class="content">
        %s
    </div>

</div>
TEMPLATE;

return $templater->render( $html, [
    'class-foo', 
    'bar',
    'The Best Title',
    'Anything you want'
] );

The result will be:

<div class="popup class-foo" data-popup="bar">
    
    <div class="title">
        The Best Title
    </div>
    
    <div class="content">
        Anything you want
    </div>
    
</div>

You can also use the numeric modifiers:

$html = <<<TEMPLATE
<div class="popup %1$s" data-popup="%2$s">
    
    <div class="title">
        %3$s
    </div>
    
    <div class="content">
        %4$s
    </div>

</div>
TEMPLATE;

Repeaters

$html = <<<TEMPLATE
<div class="popup %s" data-popup="%s">

    %s 
    [[repeater_tag_name]]
        <div class="title">
            %s
        </div>
    
        <div class="content">
            %s
        </div>
    [[/repeater_tag_name]]

</div>
TEMPLATE;

return $templater->render( $html, [
    'class-foo',
    'bar',
    [
        [ 'tag' => 'repeater_tag_name', 'data' => [ 'The Best Title', 'Anything you want.' ] ],
        [ 'tag' => 'repeater_tag_name', 'data' => [ 'There is no title', 'There is no content.' ] ],
    ]
] );

The result would be:

<div class="popup class-foo" data-popup="bar">

    <div class="title">
        The Best Title
    </div>

    <div class="content">
        Anything you want.
    </div>

    <div class="title">
        There is no title
    </div>

    <div class="content">
        There is no content.
    </div>

</div>

Nested repeater's tags

You can even put repeater's tags inside another repeater's tags.

$html = <<<TEMPLATE
<div class="popup %1$s" data-popup="%2$s">

    %3$s [[item]]
    <div class="item">
        <div class="title">%1$s</div>
        
        <div class="content">
            %2$s
            
            [[button]]
            <button id="%s">
                %s
            </button>
            [[/button]]
        </div>

    </div>
    [[/item]]

</div>
TEMPLATE;

$item_1 = [ 
    [ 'tag' => 'button', 'data' => [ 'button-1', 'Tap me' ] ], 
    [ 'tag' => 'button', 'data' => [ 'button-2', 'Do not tap me' ] ], 
];

$item_2 = [ 
    [ 'tag' => 'button', 'data' => [ 'button-3', 'I ain\'t a button' ] ], 
    [ 'tag' => 'button', 'data' => [ 'button-4', 'Ok' ] ], 
];

return $templater->render( $html, [
    'class-foo',
    'bar',
    [
        [ 'tag' => 'item', 'data' => [ 'The Best Title',  $item_1 ] ],
        [ 'tag' => 'item', 'data' => [ 'There is no title', $item_2 ] ],
    ]
] );

The result would be:

<div class="popup class-foo" data-popup="bar">

    <div class="item">
        <div class="title">The Best Title</div>
        
        <div class="content">
            <button id="button-1">
                Tap me
            </button>
            
            <button id="button-2">
                Do not tap me
            </button>
        </div>

    </div>
    
    <div class="item">
        <div class="title">There is no title</div>
        
        <div class="content">
            <button id="button-3">
                I ain't a button
            </button>
            
            <button id="button-4">
                Ok
            </button>
        </div>
    </div>
    
</div>

In fact, it does not matter what order you describe the tags. The next template is identical to the previous one functionally.

$html = <<<TEMPLATE
<div class="popup %1$s" data-popup="%2$s">
    %3$s
</div>

[[item]]
<div class="item">
	<div class="title">%1$s</div>

	<div class="content">
		%2$s
	</div>

</div>
[[/item]]

[[button]]
<button id="%s">
	%s
</button>
[[/button]]
TEMPLATE;

Predefined values

You can use predefined values for your tags. Put the predefined values in the tag separated by a pipe |. Predefined tag has not a closing part.

Predefined tag's modifier is %d and can only accept an integer value as index (starting from 0) of one of the predefined values. Any invalid modifier value will be considered as 0.

$html = <<<TEMPLATE
<div class="[[classname1|classname2|classname3/]]%d"></div>
TEMPLATE;

$result = $templater->render( $html, [
    1,
] );

The result will be:

<div class="classname2"></div>

hokoo / templater

Maintainers

Details