如何编写一个自定义树枝扩展

编辑本页

警告:您正在浏览的文档欧宝体育电话欧宝娱乐app下载地址Symfony 5.2,现已不再维护。

本页的更新版本用于Sy欧宝娱乐app下载地址mfony 6.2(当前稳定版本)。

如何编写一个自定义树枝扩展

树枝的扩展允许创建自定义函数,过滤器和更多的使用它们在你的Twig模板。在编写你自己的Twig扩展之前,检查你需要的过滤器/函数是否已经在:

创建扩展类

假设您想要创建一个名为价格将数字格式化为货币:

1 2 3 4
{{产品。价格|price }}{#传入3个可选参数#}{{产品。价格|price(2, ',', '.') }}

创建一个可扩展的类AbstractExtension然后填入逻辑:

12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23
/ / src /理解/ AppExtension.php名称空间应用程序嫩枝使用嫩枝扩展AbstractExtension使用嫩枝TwigFilterAppExtension扩展AbstractExtension公共函数getFilters()返回TwigFilter (“价格”, (“formatPrice”)));}公共函数formatPrice数量小数0decPoint“。”thousandsSep”、“价格= number_format (数量小数decPointthousandsSep);价格“美元”价格返回价格;}}

如果要创建函数而不是筛选器,请定义getFunctions ()方法:

12 3 4 5 6 7 8 9 10 11 12 13 14 16 17 18 19 20
/ / src /理解/ AppExtension.php名称空间应用程序嫩枝使用嫩枝扩展AbstractExtension使用嫩枝TwigFunctionAppExtension扩展AbstractExtension公共函数getFunctions()返回TwigFunction (“区域”, (“calculateArea”)));}公共函数calculateArea(int宽度, int长度返回宽度长度;}}

提示

除了自定义过滤器和函数,您还可以注册全局变量

将扩展注册为服务

接下来,将类注册为服务并标记为twig.extension.如果你在用默认的服务。yaml的配置,你完蛋了!欧宝娱乐app下载地址Symfony将自动了解您的新服务并添加标记。

你现在可以开始在任何Twig模板中使用你的过滤器。可选地,执行以下命令来确认您的新过滤器已成功注册:

1 2 3 4 5
#显示所有关于Twig的信息PHP bin/控制台调试:twig#只显示特定过滤器的信息PHP bin/控制台调试:twig——filter=price

创建惰性加载的树枝扩展

1.35

在Twig 1.35.0和2.4.4中引入了对惰性加载扩展的支持。

在Twig扩展类中包含自定义过滤器/函数的代码是创建扩展的最简单方法。然而,在呈现任何模板之前,Twig必须初始化所有扩展,即使模板没有使用扩展。

如果扩展没有定义依赖关系(也就是说,如果你没有在扩展中注入服务),性能不会受到影响。然而,如果扩展定义了大量复杂的依赖关系(例如那些建立数据库连接的依赖关系),性能损失可能是显著的。

这就是为什么Twig允许将扩展定义与其实现解耦的原因。与前面的示例相同,第一个更改是删除formatPrice ()中定义的PHP可调用对象getFilters ()

12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/ / src /理解/ AppExtension.php名称空间应用程序嫩枝使用应用程序嫩枝AppRuntime使用嫩枝扩展AbstractExtension使用嫩枝TwigFilterAppExtension扩展AbstractExtension公共函数getFilters()返回//这个过滤器的逻辑现在在一个不同的类中实现TwigFilter (“价格”, (AppRuntime::类,“formatPrice”)));}}

然后,创建新的AppRuntime类(这不是必需的,但这些类的后缀是运行时按照惯例),并包括前面的逻辑formatPrice ()方法:

12 3 4 5 6 7 8 9 10 11 12 13 14 16 17 18 19 20 21
/ / src /理解/ AppRuntime.php名称空间应用程序嫩枝使用嫩枝扩展RuntimeExtensionInterfaceAppRuntime实现了RuntimeExtensionInterface公共函数__construct()//这个简单的例子没有定义任何依赖项,但是在你自己的依赖项中//扩展,你需要使用这个构造函数注入服务公共函数formatPrice数量小数0decPoint“。”thousandsSep”、“价格= number_format (数量小数decPointthousandsSep);价格“美元”价格返回价格;}}

如果您使用默认设置services.yaml配置,这将已经工作!否则,创建服务对于这门课来说标记你的服务twig.runtime

此工作,包括代码示例,是根据创作共用BY-SA 3.0许可证。