内置的Symfonob娱乐下载y服务标签

编辑本页

警告:您正在浏览的文档欧宝官网下载appob娱乐下载Symfony 5.0,现已不再维护。

本页的更新版本用于Syob娱乐下载mfony 6.2(当前稳定版本)。

内置的Symfonob娱乐下载y服务标签

服务标签该机制是由DependencyInjection组件标记需要特殊处理的服务,如控制台命令或Twig扩展。

这些是Symfony组件提供的最常见的标记,但在您的应用程序中,第三方包可能提供更多可ob娱乐下载用的标记:

标签名 使用
auto_alias 根据容器参数的值定义别名
console.command 添加命令
container.hot_path 添加到总是需要的服务列表
controller.argument_value_resolver 为控制器参数注册一个值解析器,例如请求
data_collector 创建一个为分析器收集自定义数据的类
doctrine.event_listener 添加Doctrine事件监听器
doctrine.event_subscriber 添加Doctrine事件订阅者
form.type 创建自定义表单字段类型
form.type_extension 创建一个自定义的“表单扩展”
form.type_guesser 为“表单类型猜测”添加自己的逻辑
kernel.cache_clearer 注册在缓存清理过程中调用的服务
kernel.cache_warmer 注册在缓存升温过程中调用的服务
kernel.event_listener 在Symfony中聆听不同的事件/钩子ob娱乐下载
kernel.event_subscriber 在Symfony中订阅一组不同的事件/钩子ob娱乐下载
kernel.fragment_renderer 添加新的HTTP内容呈现策略
kernel.reset 允许在请求之间清理服务
mime.mime_type_guesser 添加您自己的逻辑来猜测MIME类型
monolog.logger 使用自定义日志通道进行日志记录
monolog.processor 为日志记录添加一个自定义处理器
routing.loader 注册一个加载路由的自定义服务
routing.expression_language_provider 为路由中的表达式语言函数注册提供程序
security.expression_language_provider 在安全性中为表达式语言函数注册提供程序
security.voter 向Symfony的授权逻辑添加一个自定义投票ob娱乐下载人
security.remember_me_aware 允许“记得我”认证
serializer.encoder 中注册一个新的编码器序列化器服务
serializer.normalizer 类中注册一个新的规范化项序列化器服务
swiftmailer.default.plugin 注册一个自定义SwiftMailer Plugin
translation.loader 注册一个加载翻译的自定义服务
translation.extractor 注册一个自定义服务,从文件中提取翻译消息
translation.dumper 注册一个转储翻译消息的自定义服务
twig.extension 注册一个自定义分支扩展
twig.loader 注册一个加载Twig模板的自定义服务
twig.runtime 注册一个惰性加载的分支扩展
validator.constraint_validator 创建您自己的自定义验证约束
validator.initializer 注册一个在验证之前初始化对象的服务

auto_alias

目的:根据容器参数的值定义别名

考虑下面的配置,它定义了三个不同但相关的服务:

  • YAML
  • XML
  • PHP
1 2 3 4 5 6 7
服务:app.mysql_lock:类:应用\ \ MysqlLock锁app.postgresql_lock:类:应用\ \ PostgresqlLock锁app.sqlite_lock:类:应用\ \ SqliteLock锁

应用程序不需要处理这三个服务,而是需要一个通用服务app.lock服务,该服务将是这些服务之一的别名,具体取决于某些配置。多亏了auto_alias选项,则可以根据配置参数的值自动创建该别名。

考虑到配置参数叫做database_type的存在。然后是通用的app.lock服务的定义如下:

  • YAML
  • XML
  • PHP
1 2 3 4 5 6 7 8 9 10
服务:app.mysql_lock:#……app.postgresql_lock:#……app.sqlite_lock:#……app.lock:标签:-名称:auto_alias,格式:“应用,% database_type % _lock”

格式选项定义用于构造为别名的服务名称的表达式。这个表达式可以使用任何容器参数(像往常一样,将它们的名称包装为字符)。

请注意

当使用auto_alias标记,将别名服务定义为私有并不是强制性的。然而,这样做(就像上面的例子一样)在大多数情况下是有意义的,可以防止直接访问这些服务,而不是使用通用服务别名。

请注意

需要手动添加ob娱乐下载\组件\ DependencyInjection\编译器\ AutoAliasServicePass编译器传递给容器以使该特性工作。

console.command

目的:向应用程序添加命令

有关在服务容器中注册自己的命令的详细信息,请阅读如何将命令定义为服务

container.hot_path

目的:添加到始终需要的服务列表

该标记标识始终需要的服务。它只应用于非常短的引导服务列表(比如路由器event_dispatchhttp_kernelrequest_stack等)。然后,将其传播到这些服务的所有依赖项,对于事件侦听器有一个特殊情况,只有列出的事件被传播到相关的侦听器。

它将在缓存中替换生成的服务工厂,PHP自动加载为普通内联include_once.这样做的好处是完全绕过了服务及其类层次结构的自动加载器。结果是显著的性能改进。

使用此标记时要非常谨慎,必须确保始终使用带标记的服务。

controller.argument_value_resolver

目的:为控制器参数注册一个值解析器请求

值解析器实现ArgumentValueResolverInterface和用于解析控制器的参数值,如下所示:扩展动作参数解析

data_collector

目的:创建一个为分析器收集自定义数据的类

有关创建自己的自定义数据集合的详细信息,请阅读如何创建自定义数据收集器篇文章。

doctrine.event_listener

目的:添加Doctrine事件监听器

有关创建Doctrine事件监听器的详细信息,请阅读主义事件篇文章。

doctrine.event_subscriber

目的:添加Doctrine事件订阅者

有关创建Doctrine事件订阅者的详细信息,请阅读主义事件篇文章。

form.type

目的:创建自定义表单字段类型

有关创建自己的自定义表单类型的详细信息,请阅读如何创建自定义表单字段类型篇文章。

form.type_extension

目的:创建一个自定义的“表单扩展”

有关创建表单类型扩展的详细信息,请阅读如何创建一个表单类型扩展篇文章。

form.type_guesser

目的:为“表单类型猜测”添加自己的逻辑

标记允许您将自己的逻辑添加到形式猜测的过程。默认情况下,表单猜测是由基于验证元数据和Doctrine元数据(如果使用Doctrine)或Propel元数据(如果使用Propel)的“猜测者”完成的。

另请参阅

有关如何创建自己的类型猜测器的信息,请参见创建一个自定义类型猜测器

kernel.cache_clearer

目的:将您的服务注册为清理缓存过程中调用的服务

每次调用都会发生缓存清理缓存:清晰命令。如果你的bundle缓存文件,你应该在缓存清理过程中添加自定义缓存清理器来清除这些文件。

为了注册你的自定义缓存清理器,首先你必须创建一个服务类:

12 3 4 5 6 7 8 9 10 11 12
/ / src /缓存/ MyClearer.php名称空间应用程序缓存使用ob娱乐下载组件HttpKernelCacheClearerCacheClearerInterfaceMyClearer实现了CacheClearerInterface公共函数清晰的cacheDirectory//清除缓存}}

如果你在用默认的服务。yaml的配置,您的服务将自动标记为kernel.cache_clearer.但是,你也可以手动注册:

  • YAML
  • XML
  • PHP
1 2 3
服务:应用程序缓存\ \ MyClearer:标签:(kernel.cache_clearer)

kernel.cache_warmer

目的:注册在缓存升温过程中被调用的服务

方法时,缓存升温都会发生缓存:热身缓存:清晰命令(除非你通过——no-warmup缓存:清晰)。它也会在处理请求时运行,如果其中一个命令还没有完成请求的话。

目的是初始化应用程序将需要的任何缓存,并防止第一个用户在动态生成缓存的情况下受到任何重要的“缓存命中”。

要注册自己的缓存预热器,首先创建一个实现CacheWarmerInterface接口:

12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/ / src /缓存/ MyCustomWarmer.php名称空间应用程序缓存使用ob娱乐下载组件HttpKernelCacheWarmerCacheWarmerInterfaceMyCustomWarmer实现了CacheWarmerInterface公共函数热身cacheDirectory/ /……做一些操作来“加热”你的缓存公共函数isOptional()返回真正的;}}

isOptional ()方法应返回true,如果可以在不调用此缓存预热器的情况下使用应用程序。在Syob娱乐下载mfony中,默认情况下总是执行可选的暖器(您可以使用——no-optional-warmers选项)。

如果你在用默认的服务。yaml的配置,您的服务将自动标记为kernel.cache_warmer.但是,你也可以手动注册:

  • YAML
  • XML
  • PHP
1 2 3 4
服务:应用程序缓存\ \ MyCustomWarmer:标签:-名称:kernel.cache_warmer,优先级:0

请注意

优先级是可选的,其值为正整数或负整数,默认为0.数值越高,预热器执行得越早。

谨慎

如果您的缓存温暖器因为任何异常而执行失败,Symfony将不会尝试为下一个请求再次执行它。ob娱乐下载因此,当缓存预热器生成的内容不可用时,您的应用程序和/或包应该做好准备。

除了您自己的缓存预热器外,Symfony组件和第三方包也为自己的目的定义了缓存ob娱乐下载预热器。你可以用下面的命令列出它们:

1
PHP bin/console debug:container——tag=kernel.cache_warm . PHP bin/console debug:container——tag=kernel.cache_warm . PHP

kernel.event_listener

目的:在Symfony中收听不同的事件/钩子ob娱乐下载

在Symfony应用程序执行期间,会触发不同的事件,ob娱乐下载您还可以分派自定义事件。这个标记允许您这样做你自己的类到任何这些事件中。

有关此侦听器的完整示例,请阅读事件和事件监听器篇文章。

核心事件监听器参考

有关与每个内核事件关联的事件侦听器的参考,请参见ob娱乐下载Symfony事件参考

kernel.event_subscriber

目的:在Symfony中订阅一组不同的事件/钩子ob娱乐下载

这是创建事件侦听器的另一种方法,也是推荐的方法(而不是使用kernel.event_listener)。看到事件和事件监听器

kernel.fragment_renderer

目的:增加新的HTTP内容呈现策略

添加一个新的渲染策略-除了核心策略一样EsiFragmentRenderer-创建一个实现FragmentRendererInterface,将其注册为服务,然后标记为kernel.fragment_renderer

kernel.reset

目的:清理请求之间的服务

kernel.terminate事件时,Symob娱乐下载fony将查找任何标记为kernel.reset标记来重新初始化它们的状态。方法中配置名称的方法可以实现这一点方法标记的参数。

当在应用服务器中运行项目时,这非常有用,这些应用服务器在请求之间重用Symfony应用程序以提高性能。ob娱乐下载例如,此标记应用于内置数据收集器删除他们所有的信息。

mime.mime_type_guesser

目的:添加您自己的逻辑来猜测MIME类型

此标记用于注册您自己的标记MIME类型猜测器以防猜测者提供的Mime组件不符合你的需求。

monolog.logger

目的:使用Monolog的自定义日志通道

Monolog允许您在几个日志通道之间共享它的处理程序。记录器服务使用通道应用程序但是您可以在将记录器注入服务时更改通道。

  • YAML
  • XML
  • PHP
1 2 3 4 5
服务:应用程序日志\ \ customlog:参数:(“@logger”)标签:-名称:monolog.logger,渠道:应用程序

提示

你可以创建自定义频道甚至自动连接日志通道

monolog.processor

目的:添加用于日志记录的自定义处理器

Monolog允许您在记录器或处理程序中添加处理器,以便在记录中添加额外的数据。类中添加一些额外数据后,处理器必须返回该记录作为参数额外的记录的属性。

内置的IntrospectionProcessor可用于添加触发记录器的文件、行、类和方法。

你可以全局添加处理器:

  • YAML
  • XML
  • PHP
1 2 3
服务:独白\处理器\ IntrospectionProcessor:标签:(monolog.processor)

提示

如果您的服务不是可调用的(使用__invoke ()),您可以添加方法属性中使用特定的方法。

方法还可以为特定处理程序添加处理器处理程序属性:

  • YAML
  • XML
  • PHP
1 2 3 4
服务:独白\处理器\ IntrospectionProcessor:标签:-名称:monolog.processor,处理程序:firephp

方法还可以为特定的日志记录通道添加处理器通道属性。方法注册处理器安全安全组件中使用的日志通道:

  • YAML
  • XML
  • PHP
1 2 3 4
服务:独白\处理器\ IntrospectionProcessor:标签:-名称:monolog.processor,渠道:安全

请注意

你不能同时使用处理程序而且通道作为处理程序的相同标记的属性在所有通道之间共享。

routing.loader

目的:注册加载路由的自定义服务

要启用自定义路由加载器,请将其作为常规服务添加到您的配置中,并使用routing.loader

  • YAML
  • XML
  • PHP
1 2 3
服务:应用\ \ CustomLoader路由:标签:(routing.loader)

有关更多信息,请参见如何创建自定义路由加载器

routing.expression_language_provider

目的:为路由中的表达式语言函数注册一个提供者

此标记用于自动注册表达式函数提供程序用于路由表达式组件。使用这些提供程序,您可以向路由表达式语言添加自定义函数。

security.expression_language_provider

目的:在安全中为表达式语言函数注册一个提供者

此标记用于自动注册表达式函数提供程序用于安全表达式组件。使用这些提供程序,您可以向安全表达式语言添加自定义函数。

security.remember_me_aware

目的:允许“记得我”身份验证

该标记在内部使用,以允许remember-me身份验证工作。如果您有一个自定义身份验证方法,其中用户可以通过“记住我”身份验证,那么您可能需要使用这个标记。

如果您的自定义身份验证工厂扩展AbstractFactory并扩展您的自定义身份验证侦听器AbstractAuthenticationListener,那么您的自定义身份验证侦听器将自动应用此标记并自动运行。

security.voter

目的:向Symfony的授权逻辑中添加自定义投票人ob娱乐下载

当你打电话时isGranted ()在Syob娱乐下载mfony的授权检查器上,一个“投票者”系统在幕后被用来决定用户是否应该拥有访问权限。的security.voter标签允许您将自己的自定义投票人添加到该系统。

有关更多信息,请阅读如何使用选民检查用户权限篇文章。

serializer.encoder

目的中注册一个新的编码器序列化器服务

标记的类应该实现EncoderInterface而且DecoderInterface

详情请参见如何使用序列化器

serializer.normalizer

目的:在Serializer服务中注册一个新的规范化器

标记的类应该实现NormalizerInterface而且DenormalizerInterface

详情请参见如何使用序列化器

默认归一化器的优先级可以在registerSerializerConfiguration ()方法。

swiftmailer.default.plugin

目的:注册自定义SwiftMailer Plugin

如果你正在使用一个自定义的SwiftMailer插件(或者想要创建一个),你可以通过为你的插件创建一个服务并标记它来注册到SwiftMailerswiftmailer.default.plugin(它没有选择)。

请注意

默认的在这个标记中是邮件发送者的名称。如果您配置了多个邮件程序,或者由于某种原因更改了默认的邮件程序名称,那么您应该将其更改为您的邮件程序的名称,以便使用此标记。

SwiftMailer插件必须实现Swift_Events_EventListener接口。有关插件的更多信息,请参见SwiftMailer的插件文档欧宝官网下载app

几个SwiftMailer插件是Symfony的核心,可以通过不同的配置激活。ob娱乐下载详细信息请参见Mailer配置参考(SwiftmailerBundle)

translation.loader

目的:注册加载翻译的自定义服务

默认情况下,从文件系统中以各种不同的格式(YAML、XLIFF、PHP等)加载翻译。

现在,将加载器注册为服务并标记为translation.loader

  • YAML
  • XML
  • PHP
1 2 3 4
服务:应用翻译\ \ MyCustomLoader:标签:-名称:translation.loader,别名:箱子

别名选项是必需的,而且非常重要:它定义了将用于使用该加载器的资源文件的文件“后缀”。例如,假设您有一些定制箱子您需要加载的格式。如果你有箱子文件的法语翻译消息域名,那么你可能有一个文件翻译/ messages.fr.bin

当Symfob娱乐下载ony尝试加载箱子文件时,它将路径传递给自定义加载器美元的资源论点。然后,您可以在该文件上执行所需的任何逻辑,以便加载翻译。

如果从数据库加载翻译,仍然需要一个资源文件,但它可能是空白的,或者包含一些关于从数据库加载这些资源的信息。文件是触发load ()方法。

translation.extractor

目的:注册从文件中提取消息的自定义服务

当执行翻译:更新命令时,它使用提取器从文件中提取翻译消息。默认情况下,Symfony框架有ob娱乐下载一个TwigExtractor和一个PhpExtractor,这有助于从Twig模板和PHP文件中查找和提取翻译键。

您可以通过创建实现的类来创建自己的提取器ExtractorInterface并将服务标记为translation.extractor.标签有一个必需的选项:别名,它定义了提取器的名称:

12 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26
/ / src / Acme / DemoBundle /翻译/ FooExtractor.php名称空间AcmeDemoBundle翻译使用ob娱乐下载组件翻译ExtractorInterface使用ob娱乐下载组件翻译MessageCatalogueFooExtractor实现了ExtractorInterface受保护的前缀/** *从模板目录提取翻译消息到编目。* /公共函数提取目录, MessageCatalogue目录/ /……/** *设置应用于新发现消息的前缀。* /公共函数setPrefix前缀->前缀=前缀;}}
  • YAML
  • XML
  • PHP
1 2 3 4
服务:应用翻译\ \ CustomExtractor:标签:-名称:translation.extractor,别名:喷火

translation.dumper

目的:注册将消息转储到文件的自定义服务

译器从模板中提取所有消息后,将执行转储程序以将消息转储到特定格式的翻译文件中。

ob娱乐下载Symfony已经提供了许多转储器:

您可以通过扩展创建自己的转储器FileDumper或实现DumperInterface并将服务标记为translation.dumper.标签有一个选项:别名这是用来确定应该使用哪个转储器的名称。

  • YAML
  • XML
  • PHP
1 2 3 4
服务:应用翻译\ \ JsonFileDumper:标签:-名称:translation.dumper,别名:json

twig.extension

目的:注册自定义分支扩展

要启用Twig扩展,请将其作为常规服务添加到您的配置中,并使用twig.extension.如果你在用默认的服务。yaml的配置,该服务是自动注册和自动标记的。但是,你也可以手动注册:

  • YAML
  • XML
  • PHP
1 2 3 4 5 6 7 8 9
服务:App \树枝\ AppExtension:标签:(twig.extension)#你可以选择定义扩展的优先级(default = 0)。优先级高的扩展被更早地注册。这主要是#用于注册覆盖其他扩展的晚期扩展。App \树枝\ AnotherExtension:标签:[{名称:twig.extension,优先级:-100年})

有关如何创建实际的树枝扩展类的信息,请参见树枝的文档欧宝官网下载app关于这个话题或阅读如何编写一个自定义树枝扩展篇文章。

twig.loader

目的:注册一个加载Twig模板的自定义服务

默认情况下,Symfonob娱乐下载y只使用一个树枝装载机-FilesystemLoader.如果您需要从其他资源加载Twig模板,您可以为新的加载器创建一个服务并标记它twig.loader

如果你使用默认的服务。yaml的配置,由于自动配置,该服务将被自动标记。但是,你也可以手动注册:

  • YAML
  • XML
  • PHP
1 2 3 4
服务:App \树枝\ CustomLoader:标签:-名称:twig.loader,优先级:0

请注意

优先级是可选的,其值为正整数或负整数,默认为0.先试数较大的装载机。

twig.runtime

目的:注册一个自定义惰性加载树枝扩展

惰性加载树枝扩展被定义为常规服务但需要被标记twig.runtime.如果你在用默认的服务。yaml的配置,该服务是自动注册和自动标记的。但是,你也可以手动注册:

  • YAML
  • XML
  • PHP
1 2 3
服务:App \树枝\ AppExtension:标签:(twig.runtime)

validator.constraint_validator

目的:创建自己的自定义验证约束

该标记允许您创建和注册自己的自定义验证约束。有关更多信息,请阅读如何创建自定义验证约束篇文章。

validator.initializer

目的:注册一个在验证前初始化对象的服务

这个标记提供了一个非常不寻常的功能,允许您在对象验证之前对其执行某种操作。例如,Doctrine使用它在验证对象之前查询对象上的所有惰性加载数据。如果没有这一点,在验证时Doctrine实体上的一些数据就会显得“缺失”,尽管实际情况并非如此。

如果确实需要使用此标记,只需创建一个新类来实现ObjectInitializerInterface接口。然后,标记它与validator.initializer标签(它没有选项)。

有关示例,请参见DoctrineInitializer在教义桥里面上课。

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