You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
72 lines
2.2 KiB
72 lines
2.2 KiB
<?php
|
|
|
|
/*
|
|
* This file is part of the Symfony package.
|
|
*
|
|
* (c) Fabien Potencier <fabien@symfony.com>
|
|
*
|
|
* 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 rely 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 uses the logical template name to look for
|
|
* the template.
|
|
*
|
|
* @author Fabien Potencier <fabien@symfony.com>
|
|
*
|
|
* @api
|
|
*/
|
|
interface EngineInterface
|
|
{
|
|
/**
|
|
* Renders a template.
|
|
*
|
|
* @param string|TemplateReferenceInterface $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
|
|
*/
|
|
public function render($name, array $parameters = array());
|
|
|
|
/**
|
|
* Returns true if the template exists.
|
|
*
|
|
* @param string|TemplateReferenceInterface $name A template name or a TemplateReferenceInterface instance
|
|
*
|
|
* @return bool true if the template exists, false otherwise
|
|
*
|
|
* @throws \RuntimeException if the engine cannot handle the template name
|
|
*
|
|
* @api
|
|
*/
|
|
public function exists($name);
|
|
|
|
/**
|
|
* Returns true if this class is able to render the given template.
|
|
*
|
|
* @param string|TemplateReferenceInterface $name A template name or a TemplateReferenceInterface instance
|
|
*
|
|
* @return bool true if this class supports the given template, false otherwise
|
|
*
|
|
* @api
|
|
*/
|
|
public function supports($name);
|
|
}
|
|
|