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 41 42 43 44 45 46 47 48 49 50 51
<?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 resolvers.
*
* @package ICanBoogie\Render
*/
interface TemplateResolver
{
/**
* Returns the pathname to the matching template.
*
* @param string $name The base name of the template.
* @param array $extensions The supported extensions.
* @param array $tried Tried pathname collection.
*
* @return string|false The pathname to the matching template or `false` if none match.
*/
public function resolve($name, array $extensions, &$tried = []);
/**
* Adds a path to search templates in.
*
* Note: The path is discarded if it cannot be resolved with `realpath()`.
*
* @param string $path
* @param int $weight
*
* @return string|false The real path, or `false` if the path was not added.
*/
public function add_path($path, $weight = 0);
/**
* Returns the paths used to search templates.
*
* @return array
*/
public function get_paths();
}