首页 > 解决方案 > 扩展 Symfony 以自动转义 .tex.twig 文件的乳胶字符

问题描述

我正在使用.tex.twig文件在我的项目中生成一些 PDF。默认情况下,我所有的树枝文件都使用html策略自动转义。为了阻止意外转义,我不得不将所有.tex.twig文件包装在一个autoescape false块中。
我想保留文件的默认html转义.html.twig,但在渲染文件时使用我自己的乳胶转义方法.tex.twig。我找到了一种使用以下代码扩展 twig 环境的方法:

//LatexEscapeSetter.php
public function __invoke(Environment $twig)
{
    $twig->getExtension('Twig_Extension_Core')
        ->setEscaper('latex',
                     function ($twig, $string, $charset) {
                         // Escaping logic here....
                     }
        );

    return $twig;
}

为了调用此方法,我在我的 中创建了以下定义services.yml

Twig_Environment:
    class: Twig_Environment
    factory: ['LatexEscapeSetter.php', '__invoke']
    arguments: ['@twig']

重新启动服务器后,我使用var_dump($twig->getExtensions())并实际上注意到核心扩展确实包含一个latex条目。但是{% autoescape 'latex' %}在我的一个 html 页面中使用作为测试没有任何影响。
我错过了什么?

标签: phpsymfonytwiglatextex

解决方案


这就是你的做法:

首先需要在 twig 命名空间下配置 autoescape_service 和 autoescape_service_method 配置。

twig:
    autoescape_service: 'App\Twig\EscapeStrategy'
    autoescape_service_method: guess

逃生策略服务必须在 config/services.yaml 或您的自定义服务定义文件中注册:

services:
    App\Twig\EscapeStrategy: ~

在您的用例中,EscapeStrategy 可能如下所示:

<?php

namespace App\Twig;
use Twig\FileExtensionEscapingStrategy;

class EscapeStrategy
{

    const STRATEGY_NAME = 'latex';

    public function guess($name)
    {
        if ('.tex.twig' === substr($name, -9)) {
            return self::STRATEGY_NAME;
        }

        return FileExtensionEscapingStrategy::guess($name);
    }
}

symfony 默认使用 FileExtensionEscapingStrategy,所以回退到它的默认猜测器是个好主意。

如果您尝试渲染名称以“.tex.twig”结尾的模板,您将收到异常,因为该“乳胶”策略的处理程序不存在。

要为新的逃生策略注册处理程序,您需要装饰一个 twig 服务。在 services.yaml 中:

services:
    App\Twig\Configurator:
        decorates: 'twig.configurator.environment'

实现可能是这样的:

<?php

namespace App\Twig;

use Symfony\Bundle\TwigBundle\DependencyInjection\Configurator\EnvironmentConfigurator;
use Twig\Environment;
use Twig\Extension\EscaperExtension;

class Configurator
{

    /**
     * @var EnvironmentConfigurator
     */
    private $configurator;

    public function __construct(EnvironmentConfigurator $configurator)
    {
        $this->configurator = $configurator;
    }

    public function configure(Environment $environment)
    {
        $environment->getExtension(EscaperExtension::class)->setEscaper(EscapeStrategy::STRATEGY_NAME, [$this, 'escape']);

        $this->configurator->configure($environment);
    }

    public function escape($twig, $string, $charset)
    {
        //implement escape here
        return $string;
    }
}

如果您不使用自动装配检查文档https://symfony.com/doc/current/service_container/service_decoration.html

无论开发或生产环境如何,还要确保清除缓存。


推荐阅读