1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 <?php
/*
* This file is part of the ICanBoogie package.
*
* (c) Olivier Laviale <olivier.laviale@gmail.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace ICanBoogie\Render;
/**
* An interface for template engines.
*/
interface Engine
{
/**
* The pathname of the template being rendered.
*/
const VAR_TEMPLATE_PATHNAME = '__TEMPLATE_PATHNAME__';
/**
* Renders a template.
*
* **Note**: Template engines implementing this interface are expected to add
* {@link VAR_TEMPLATE_PATHNAME} to the variables, so that the template being rendered can be
* tracked easily.
*
* @param string $template_pathname Pathname to the template to render.
* @param mixed $thisArg _thisArg_, if supported by the engine.
* @param array $variables Variable to render the template with.
* @param array $options Miscellaneous options.
*
* @return mixed
*/
public function render($template_pathname, $thisArg, array $variables, array $options = []);
}