如何使用服务标签

编辑该页面

警告:你浏览的文档欧宝官网下载appob娱乐下载Symfony 2.8,不再维护。

这个页面的更新版本Symfob娱乐下载ony 6.2(当前的稳定版本)。

如何使用服务标签

服务标签告诉Symfony或者其他第三方包,ob娱乐下载您的服务应该注册在某些特殊的方式。下面的例子:

  • YAML
  • XML
  • PHP
1 2 3 4 5 6 7
# app / config / services.yml服务:app.twig_extension:类:AppBundle \树枝\ AppExtension公众:标签:- - - - - -{名称:twig.extension}

服务标记twig.extension标签初始化期间收集TwigBundle添加到树枝和扩展。

其他标签用于服务集成到其他系统。可用的所有标记列表的核心Symfony框架,结账ob娱乐下载内置Symfonyob娱乐下载服务标签。这些对你的服务有不同的影响,许多标签(不仅仅是需要额外的参数的名字参数)。

创建自定义标签

标记自己实际上并不以任何方式改变您的服务的功能。但是如果你选择,你可以问一个容器建造者的所有服务的列表和一些特定的标签标记。这是有用的在编译器,您可以找到这些服务和在一些特定的方式使用或修改它们。

例如,如果您使用的是斯威夫特梅勒你想象你想实现一个“传递链”,这是一个集合类实现\ Swift_Transport。用链式,你要迅速梅勒尝试多种方式运输到一个成功的消息。

首先,定义TransportChain类:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17
/ / src / AppBundle /邮件/ TransportChain.php名称空间AppBundle\邮件;TransportChain{私人美元传输;公共函数__construct(){美元- >传输=数组();}公共函数addTransport(\ Swift_Transport美元运输){美元- >传输[]=美元运输;}}

然后,定义链作为一个服务:

  • YAML
  • XML
  • PHP
1 2 3
服务:app.mailer_transport_chain:类:AppBundle \ \ TransportChain邮件

定义服务的定制标记

现在你可能会想要一些的\ Swift_Transport类实例化并使用自动添加到链addTransport ()方法。例如,您可以添加以下运输服务:

  • YAML
  • XML
  • PHP
1 2 3 4 5 6 7 8 9 10 11
服务:app.smtp_transport:类:\ Swift_SmtpTransport参数:[' % mailer_host % ')标签:- - - - - -{名称:app.mail_transport}app.sendmail_transport:类:\ Swift_SendmailTransport标签:- - - - - -{名称:app.mail_transport}

注意,每个服务被标签命名app.mail_transport。这是自定义标签,您将使用在你的编译器通过。编译器通过使这个标记“的意思是”什么。

创建一个编译器通过

您现在可以使用编译器通过向容器的任何服务app.mail_transport标签:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17日18 19 20 21日22日23日24日25日26日27
/ / src / AppBundle DependencyInjection /编译器/ MailTransportPass.php名称空间AppBundle\DependencyInjection\编译器;使用ob娱乐下载\组件\DependencyInjection\ContainerBuilder;使用ob娱乐下载\组件\DependencyInjection\编译器\CompilerPassInterface;使用ob娱乐下载\组件\DependencyInjection\参考;MailTransportPass实现了CompilerPassInterface{公共函数过程(ContainerBuilder美元容器){/ /总首先检查如果主服务定义如果(!美元容器- >有(“app.mailer_transport_chain”)){返回;}美元定义=美元容器- >findDefinition (“app.mailer_transport_chain”);/ /查找所有服务id app.mail_transport标签美元taggedServices=美元容器- >findTaggedServiceIds (“app.mail_transport”);foreach(美元taggedServices作为美元id= >美元标签){/ /添加ChainTransport服务的运输服务美元定义- >addMethodCall (“addTransport”,数组(引用(美元id)));}}}

注册通过的容器

为了运行编译器编译通过当容器,你必须编译器通过添加到容器中build ()的方法,你的包:

1 2 3 4 5 6 7 8 9 10 11 12 13
/ / src / AppBundle / AppBundle.php/ /……使用ob娱乐下载\组件\DependencyInjection\ContainerBuilder;使用AppBundle\DependencyInjection\编译器\MailTransportPass;AppBundle扩展{公共函数构建(ContainerBuilder美元容器){美元容器- >addCompilerPass (MailTransportPass ());}}

提示

当实现CompilerPassInterface在服务的扩展,您不需要注册。看到组件的文档欧宝官网下载app为更多的信息。

添加额外的属性标签

有时你需要额外信息的每个服务标记你的标签。例如,您可能想添加别名来传递链的每个成员。

首先,改变TransportChain类:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
TransportChain{私人美元传输;公共函数__construct(){美元- >传输=数组();}公共函数addTransport(\ Swift_Transport美元运输,美元别名){美元- >传输(美元别名]=美元运输;}公共函数getTransport(美元别名){如果(array_key_exists (美元别名,美元- >传输)){返回美元- >传输(美元别名];}}}

正如您可以看到的,什么时候addTransport ()被调用时,不仅需要一个吗Swift_Transport对象,也是一个字符串别名运输。所以,你怎么能让每个标记运输服务也提供一个别名吗?

要回答这个问题,改变服务宣言:

  • YAML
  • XML
  • PHP
1 2 3 4 5 6 7 8 9 10 11
服务:app.smtp_transport:类:\ Swift_SmtpTransport参数:[' % mailer_host % ')标签:- - - - - -{名称:app.mail_transport,别名:喷火}app.sendmail_transport:类:\ Swift_SendmailTransport标签:- - - - - -{名称:app.mail_transport,别名:酒吧}

注意到你已经添加了一个通用的别名标签的关键。使用这个,更新编译器:

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21日22日23日24日25
使用ob娱乐下载\组件\DependencyInjection\ContainerBuilder;使用ob娱乐下载\组件\DependencyInjection\编译器\CompilerPassInterface;使用ob娱乐下载\组件\DependencyInjection\参考;TransportCompilerPass实现了CompilerPassInterface{公共函数过程(ContainerBuilder美元容器){如果(!美元容器- >hasDefinition (“app.mailer_transport_chain”)){返回;}美元定义=美元容器- >getDefinition (“app.mailer_transport_chain”);美元taggedServices=美元容器- >findTaggedServiceIds (“app.mail_transport”);foreach(美元taggedServices作为美元id= >美元标签){foreach(美元标签作为美元属性){美元定义- >addMethodCall (“addTransport”,数组(引用(美元id),美元属性(“别名”)));}}}}

双圈可能会让人困惑。这是因为一个服务可以有多个标签。你标记两次或更多的服务app.mail_transport标签。第二个foreach循环迭代app.mail_transport标签设置为当前服务和给你的属性。

这项工作,包括代码示例,许可下Creative Commons冲锋队3.0许可证。