Dataplater

PHP template engine that uses data-attributes and keeps HTML templates valid and clean. Scroll down to see a usage example.

Install

composer require leongrdic/dataplater

Requirements

• PHP 8.0 +
• XML extension
• DOM extension

Example

template.html:

<table>
    <template data-var-foreach="users; row">
    <tr>
        <template data-var-foreach="row; cell">
        <td data-var-text="cell">td>
        template>
    tr>
    template>
table>
<span>table has <var data-var-text="f/count, users">var> rowsspan> <div> <template data-var-foreach="links; index; link"> <a data-var-href="link.url" data-var-text='f/text.concat, index, v/" ", link.name'>a><br> template> div> <div data-var-if-text='f/compare.equal, balance, v/0 ; lang.balance_empty'>Your current balance is <var data-var-text="balance">var> dollarsdiv> <ul> <template data-var-foreach='f/text.explode, v/" ", sentence, v/4 ; word'> <li data-var-text="word">li> template> ul>

PHP:

require_once 'vendor/autoload.php';

$dp = new \Le\Dataplater('template.html');
echo $dp->render([
    'users' => [
        ['Demo', 'User', '01.01.2020.'],
        ['John', 'Doe', '31.12.2021.'],
    ],
    'links' => [
        ['name' => 'Google', 'url' => 'https://google.com/'],
        ['name' => 'YouTube', 'url' => 'https://youtube.com/'],
        ['name' => 'Facebook', 'url' => 'https://facebook.com/']
    ],
    'items' => [
        'first',
        'second',
        'third',
        'fourth'
    ],
    'balance' => 10,
    'sentence' => 'split this sentence by spaces',
    'lang' => function(){
        return [
            'balance_empty' => 'Your balance is empty.',
            'some_text' => 'Translation'
        ];
    }
]);

Output:

• split
• this
• sentence
• by spaces

<table>
    <tr>
        <td>Demotd>
        <td>Usertd>
        <td>01.01.2020.td>
    tr>
    <tr>
        <td>Johntd>
        <td>Doetd> <td>31.12.2021.td> tr> table> <span>table has <var>2var> rowsspan> <div> <a href="https://google.com/">0 Googlea><br> <a href="https://youtube.com/">1 YouTubea><br> <a href="https://facebook.com/">2 Facebooka><br> div> <div>Your current balance is <var>10var> dollarsdiv> <ul> <li>splitli> <li>thisli> <li>sentenceli> <li>by spacesli> ul>

(not as nicely formatted as here)

Attributes

Expression syntax:

variableName

returns content of the variable

if variable is a closure, executes it and returns the result

variable names shouldn't contain characters like dots or spaces, but ideally they should only contain letters, numbers, _ and -

variableName.arrayElement.objectProperty

access element of array or object property when array/object is in variable

also supports closures at any depth

v/json

decodes json after /, useful for literal values like: v/true, v/false, v/0 or even strings, e.g. v/"string"

f/variableName, param, ...

calls the callable in variableName and passed provided params (if any)

params can be encapsulated into | characters if your expression contains ,

Built-in functions

Class

new Le\Dataplater\Dataplater(string $template, array $vars)

when creating an object, pass your template filename as the first constructor parameter. the second parameter is optional and can hold global variables that will be made available to each render of the template.

$dataplater->render(array $vars);

this method renders the template using global vars together with vars optionally passed as parameter and returns the rendered HTML string. you can call it multiple times on the same dataplater object to render multiple different pages.

Disclaimer

Use on your own responsibility, this may not be suitable for production - I honestly haven't benchmarked it.