如何在 symfony2 中从数据库渲染 Twig 模板

Question

我正在开发用 symfony2 编写的应用程序，我想在某些操作/事件后发送电子邮件...问题是，用户可以定义类似“电子邮件模板”之类的内容，这些模板像简单的字符串一样存储在数据库中，例如： “这是来自 {{ user }} 的一些电子邮件”，我需要渲染该电子邮件的正文，该电子邮件应使用该模板...

在 symfony 文档中，此链接： https://symfony.com/doc/2.0/cookbook/email/email .html#sending-emails 渲染视图的方法是 $this->renderView 并且它需要文件的路径，例如“bundle:controller:file.html.twig”，但我的模板是来自数据库的简单字符串...

我该如何渲染它？

Answer 1

Twig_Loader_String 已被弃用，并且始终设计为供内部使用。强烈建议不要使用此加载程序。

来自 API 文档：

切勿使用此加载程序。它仅存在于 Twig 内部
目的。当将此加载器与缓存机制一起使用时，您应该
知道每次模板内容都会生成一个新的缓存键
“更改”（缓存键是模板的源代码）。如果
你不想看到你的缓存增长失控，你需要
请自行清除旧的缓存文件。

另请查看此问题：https://github.com/symfony/symfony/issues/10865

---

我知道从字符串源加载模板的最佳方法是：

从控制器：

$template = $this->get('twig')->createTemplate('Hello {{ name }}');
$template->render(array('name'=>'World'));

如此处所述：http://twig.sensiolabs.org/doc/recipes .html#loading-a-template-from-a-string

来自树枝模板：

{{ include(template_from_string("Hello {{ name }}", {'name' : 'Peter'})) }}

如下所述：http://twig.sensiolabs.org/doc/functions/template_from_string.html

请注意，“template_from_string”函数默认不可用，需要加载。在 symfony 中，您可以通过添加新服务来做到这一点：

# services.yml
services:
    appbundle.twig.extension.string:
        class: Twig_Extension_StringLoader
        tags:
            - { name: 'twig.extension' }

Answer 2

这应该有效。将“Hello {{ name }}”替换为模板文本，并使用您需要的任何变量填充传递到渲染函数的数组。

$env = new \Twig_Environment(new \Twig_Loader_String());
echo $env->render(
  "Hello {{ name }}",
  array("name" => "World")
);

Answer 3

这是一个适用于 Symfony 4（也可能适用于旧版本，尽管我还没有测试过）的解决方案，并允许您使用存储在数据库中的模板，就像使用文件系统中的模板一样。

这个答案假设您使用的是 Doctrine，但如果您使用的是其他数据库，则相对容易适应。

创建模板实体

这是一个使用注释的示例类，但您可以使用已经使用的任何配置方法。

src/Entity/Template.php

<?php
namespace App\Entity;

use Doctrine\ORM\Mapping as ORM;

/**
 * @ORM\Table(name="templates")
 * @ORM\Entity
 */
class Template
{
    /**
     * @var int
     *
     * @ORM\Column(name="id", type="integer")
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="IDENTITY")
     */
    private $id;

    /**
     * @var string
     *
     * @ORM\Column(type="string", nullable=false)
     */
    private $filename;

    /**
     * @var string
     *
     * @ORM\Column(type="text", nullable=false)
     */
    private $source;

    /**
     * @var \DateTime
     *
     * @ORM\Column(type="datetime", nullable=false)
     */
    private $last_updated;
}

最低限度的字段是 filename 和 source，但包含 last_updated< 是一个非常好的主意/code> 否则你将失去缓存的好处。

创建DatabaseLoader类

src/Twig/Loader/DatabaseLoader.php

<?php
namespace App\Twig\Loader;

use App\Entity\Template;
use Doctrine\ORM\EntityManagerInterface;
use Twig_Error_Loader;
use Twig_LoaderInterface;
use Twig_Source;

class DatabaseLoader implements Twig_LoaderInterface
{
    protected $repo;

    public function __construct(EntityManagerInterface $em)
    {
        $this->repo = $em->getRepository(Template::class);
    }

    public function getSourceContext($name)
    {
        if (false === $template = $this->getTemplate($name)) {
            throw new Twig_Error_Loader(sprintf('Template "%s" does not exist.', $name));
        }

        return new Twig_Source($template->getSource(), $name);
    }

    public function exists($name)
    {
        return (bool)$this->getTemplate($name);
    }

    public function getCacheKey($name)
    {
        return $name;
    }

    public function isFresh($name, $time)
    {
        if (false === $template = $this->getTemplate($name)) {
            return false;
        }

        return $template->getLastUpdated()->getTimestamp() <= $time;
    }

    /**
     * @param $name
     * @return Template|null
     */
    protected function getTemplate($name)
    {
        return $this->repo->findOneBy(['filename' => $name]);  
    }
}

该类比较简单。 getTemplate 从数据库中查找模板文件名，其余方法使用 getTemplate 来实现 Twig 需要的接口。

将 DatabaseLoader 添加到您的服务配置

config/services.yaml

services:
    App\Twig\Loader\DatabaseLoader:
        tags:
        - { name: twig.loader }

现在您可以像使用文件系统模板一样使用数据库模板。

从控制器渲染：

return $this->render('home.html.twig');

包括来自另一个 Twig 模板（其中可以在数据库或文件系统中）：

{{ include('welcome.html.twig') }}

渲染为字符串（其中 $twig 是一个实例Twig\Environment)

$html = $twig->render('email.html.twig')

在每种情况下，Twig 都会首先检查数据库。如果 DatabaseLoader 中的 getTemplate 返回 null，Twig 将检查文件系统。如果模板在数据库或文件系统中不可用，Twig 将抛出 Twig_Error_Loader。

Answer 4

克隆本机 twig 服务并用本机 twig 字符串加载器替换文件系统加载器：

<service id="my.twigstring" class="%twig.class%">
    <argument type="service" id="my.twigstring.loader" />
    <argument>%twig.options%</argument>
</service>        
<service id="my.twigstring.loader" class="Twig_Loader_String"></service>

控制器内的使用示例：

$this->get('my.twigstring')->render('Hello {{ name }}', array('name' => 'Fabien'));

Answer 5

最好的方法是使用 template_from_string twig 函数。

{{ include(template_from_string("Hello {{ name }}")) }}
{{ include(template_from_string(page.template)) }}

请参阅template_from_string的文档

了解为什么它不 最好在 Twig_Loader_Chain 或 Twig_Loader_String 来实现此目的href="https://github.com/symfony/symfony/issues/10865">stof 的这个 github 问题。

Answer 6

从 Twig 1.10 开始，Twig 引擎不支持渲染字符串。但是有一个可用的捆绑包添加了此行为，称为 TwigstringBundle。

它添加了 $this->get('twigstring') 服务，您可以使用它来渲染字符串。

_{（截至 2019 年 9 月，Twig 的当前版本为 2.X，版本 3 即将推出；因此这仅适用于非常旧的 Twig 版本）。}

Answer 7

这对我有用：

$loader = new \Twig\Loader\ArrayLoader([
    'Temp_File.html' => 'Hello {{ name }}!',
]);
$twig = new \Twig\Environment($loader);

echo $twig->render('Temp_File.html', ['name' => 'Fabien']);

https://twig.symfony.com/doc/2 .x/api.html

Answer 8

仅供参考，此功能建议为建议。 com/fabpot/Twig/commit/bf3802bc6e5199b4d065b383caf3fe81203b713d" rel="nofollow">添加从 1.11.0 开始，Twig 的核心，但需要激活由开发商。

Answer 9

在 Symfony 2.2 中，您可以使用 Twig_Chain_Loader
如何注册另一个（自定义）Twig Symfony2 环境中的加载器？

Answer 10

我最近必须实现一个由多方使用的 CMS，其中每一方都可以完全自定义他们的模板。为了实现这一点，我实现了一个自定义的 Twig Loader。

最困难的部分是为模板制定一个命名约定，保证不与任何现有模板重叠，例如 !AppBundle:template.html.twig。
如果模板未自定义，则必须加载模板 AppBundle:template.html.twig 作为后备模板。

然而，这对于 Chain Loader (AFAIK) 来说是不可能的，因为模板名称无法修改。因此，我必须将默认加载器（即加载器链）注入到我的加载器中，并使用它来加载后备模板。

另一种解决方案是将请求堆栈或会话传递给模板加载器，从而可以自动检测组织，但这很困难，因为安全组件依赖于模板子系统，从而导致循环依赖问题。

Answer 11

  $message = \Swift_Message::newInstance()
        ->setSubject('Hello Email')
        ->setFrom('[email protected]')
        ->setTo('[email protected]')
        ->setBody('hai its a sample mail')
    ;
    $this->get('mailer')->send($message);