Template

The Pebble\Template class is used for creating secure HTML templates. It uses the Pebble\Special class for encoding the template variables. Every HTML entity is encoded by default.

The class has four methods:

Template::getOutput($variables_ary, 'path/to/template.php'). Return output of a template as a string
Template::getOutputRaw($variables_ary, 'path/to/template.php'). Return output of a template as a string with no encoding
Template::render($variables_ary, 'path/to/template.php'). Output the parsed templates directly to stdout (e.g. the browser).
Template::renderRaw($variables_ary, 'path/to/template.php'). Output the parsed templates directly to stdout (e.g. the browser) with no encoding.

Let's create a main page template with the variables $title and $content in the src/templates dir. This is the dir where all templates are placed for the examples.

src/templates/main.php ->

<!DOCTYPE html>
<html>

<head>
    <title><?= $title ?></title>
</head>

<body>

    <h1>
        <?= $title ?>
    </h1>

    <p>
        <?= $content ?>
    </p>

</body>

</html>

We will also create a page template for showing content. We create some paragraphs and then we loop over each one of them.

src/templates/page.php ->

<h3>Hi <?=$username?></h3>

<p>Here is a bunch of paragraphs just for you!</p>

<?php

foreach ($paragraphs as $paragraph): ?>
<p><?=$paragraph?></p>
<hr>
<?php

endforeach;

We add a new controller class called TemplateTest in the src dir.

src/TemplateTest.php ->

<?php

namespace App;

use Pebble\Template;
use Pebble\Attributes\Route;
use Pebble\Router\Request;

class TemplateTest {

    #[Route(path: '/user/:username')]
    public function userGreeting(Request $request) {

        $variables['title'] = 'Greeting with paragraphs'; 
        $variables['username'] = $request->param('username');
        $variables['paragraphs'] = [
            'Hi <w><o><o> ' . $request->param('username') . '<o><o><h> !', 
            'Nice day today!', 
            'Did they build a wall?', 
            'No, they build a dam!'
        ];

        // All the variables with HTML specialchars will be auto-encoded, 
        // They are safe to output to the client
        $variables['content'] = Template::getOutput('templates/page.php', $variables);



        // All variables are already encoded, 
        // Therefor we render this template without encoding (renderRaw)
        Template::renderRaw('templates/main.php', $variables);

    } 
}

Now we can tie it all together in our index.php file

examples/template/index.php ->

<?php

require_once "../../vendor/autoload.php";

use Pebble\Router;
use Pebble\App\AppExec;
use Pebble\App\CommonUtils;

class MyApp {

    public function run () {
        $common_utils = new CommonUtils();
        $common_utils->setErrorHandler();

        // Add src to include path 
        // Then templates are loaded without adding 'src' to the path
        $common_utils->addSrcToIncludePath();

        $router = new Router();
        $router->addClass(App\TemplateTest::class);
        $router->run();

    }
}

$app_exec = new AppExec();
$app_exec->setApp(MyApp::class);
$app_exec->run();

Run the application:

php -S localhost:8000 -t examples/template

Visit a route that does not exist and you will get an error, e.g: http://localhost:8000/does/not/exist

Or visit a route that exists: http://localhost:8000/user/Helena

Edit this page on GitHub