EngineInterface.php

<?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;

trigger_deprecation('symfony/templating', '6.4', '"%s" is deprecated since version 6.4 and will be removed in 7.0. Use Twig instead.', EngineInterface::class);

/**
 * 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>
 *
 * @deprecated since Symfony 6.4, use Twig instead
 */
interface EngineInterface
{
    /**
     * Renders a template.
     *
     * @throws \RuntimeException if the template cannot be rendered
     */
    public function render(string|TemplateReferenceInterface $name, array $parameters = []): string;

    /**
     * Returns true if the template exists.
     *
     * @throws \RuntimeException if the engine cannot handle the template name
     */
    public function exists(string|TemplateReferenceInterface $name): bool;

    /**
     * Returns true if this class is able to render the given template.
     */
    public function supports(string|TemplateReferenceInterface $name): bool;
}