diff -r 000000000000 -r 7f95f8617b0b vendor/symfony/src/Symfony/Component/Templating/EngineInterface.php --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/vendor/symfony/src/Symfony/Component/Templating/EngineInterface.php Sat Sep 24 15:40:41 2011 +0200 @@ -0,0 +1,70 @@ + + * + * For the full copyright and license information, please view the LICENSE + * file that was distributed with this source code. + */ + +namespace Symfony\Component\Templating; + +/** + * EngineInterface is the interface each engine must implement. + * + * All methods relies on a template name. A template name is a + * "logical" name for the template, and as such it does not refer to + * a path on the filesystem (in fact, the template can be stored + * anywhere, like in a database). + * + * The methods should accept any name. If the name is not an instance of + * TemplateReferenceInterface, a TemplateNameParserInterface should be used to + * convert the name to a TemplateReferenceInterface instance. + * + * Each template loader use the logical template name to look for + * the template. + * + * @author Fabien Potencier + * + * @api + */ +interface EngineInterface +{ + /** + * Renders a template. + * + * @param mixed $name A template name or a TemplateReferenceInterface instance + * @param array $parameters An array of parameters to pass to the template + * + * @return string The evaluated template as a string + * + * @throws \RuntimeException if the template cannot be rendered + * + * @api + */ + function render($name, array $parameters = array()); + + /** + * Returns true if the template exists. + * + * @param mixed $name A template name or a TemplateReferenceInterface instance + * + * @return Boolean true if the template exists, false otherwise + * + * @api + */ + function exists($name); + + /** + * Returns true if this class is able to render the given template. + * + * @param mixed $name A template name or a TemplateReferenceInterface instance + * + * @return Boolean true if this class supports the given template, false otherwise + * + * @api + */ + function supports($name); +}