mindplay/kisstpl

View service / template engine for plain PHP templates

mindplay/kisstpl

, _(*1)

A very simple view-service / template-engine for plain PHP templates., _(*2)

I wanted a template engine that uses view-models (objects) rather than view-dictionaries (arrays) as are typical in most PHP template engines., _(*3)

Oh, and if you don't like typing htmlspecialchars() all day, maybe try this., _(*4)

The view-service is tied to a root folder and a root namespace:, _(*5)

$service = new ViewService(new SimpleViewFinder('my/app/views', 'app\view'));

$hello = new \app\view\HelloWorld();

$service->render($hello); // -> "my/app/views/HelloWorld.view.php"

The render() statement in this example will render the template my/app/views/HelloWorld.view.php, passing the view-model object to the rendered template as $view - the SimpleViewFinder is responsible for locating the actual template based on the type of view-model., _(*6)

The render() method also accepts a second argument, allowing you to render different templates for the same view-model:, _(*7)

$service->render($hello, 'boom'); // -> "my/app/views/HelloWorld.boom.php"
$service->render($hello, 'bang'); // -> "my/app/views/HelloWorld.bang.php"

You can type-hint in the beginning of a template file for IDE support:, _(*8)

...

Alternatively, for type-safe template rendering, you can also type-hint statically, by returning a closure:, _(*9)

use app\view\HelloWorld;
use mindplay\kisstpl\Renderer;


...
layout->title = 'My Page!';

$this->begin($view->layout->body);

?>


Hello!




Body content goes here..., (*10)



<?php

$this->end($view->layout->body);

$this->render($view->layout);

Note that begin() and end() take variable references as arguments - the call to end() will apply the captured content to $view->layout->body., _(*11)

There is deliberately no view rendering "pipeline", or any concept of layout, and this is "a good thing" - your templates have complete control of the rendering process, you have IDE support all the way,, _(*12)

You can also capture rendered content and return it, instead of sending the rendered content to output:, _(*13)

$content = $service->capture($hello);

You can use this feature to implement "partials", since it can be called from within a template. Like render(), the capture() method also accepts a second argument allowing you to render different views of the same view-model., _(*14)

You can of course also extend ViewService with custom functionality - an interface Renderer defines the four basic methods, render(), capture(), begin() and end() so you can type-hint and swap out implementations as needed., _(*15)

You can also replace the ViewFinder implementation if you need custom logic (specific to your project) for locating templates. A few implementations are included:, _(*16)

• SimpleViewFinder for direct 1:1 class-to-file mapping (and zero overhead from calls to file_exists()) with a specified base namespace and root path., _(*17)

• LocalViewFinder for direct 1:1 class-to-file mapping (and zero overhead) not limited to any particular namespace, and assuming local view-files located in the same path as the view-model class file., _(*18)

• DefaultViewFinder which searches a list of root-paths and defaults to the first template found., _(*19)

• MultiViewFinder which allows you to aggregate as many other ViewFinder instances as you need, and try them in order., _(*20)

The latter is useful in modular scenarios, e.g. using a "theme" folder for template overrides, allowing you to plug in as many conventions for locating views as necessary., _(*21)