创建和发送通知
编辑该页面警告:你浏览的文档欧宝体育电话欧宝娱乐app下载地址Symfony 5.3,不再维护。
读这个页面的更新版本Symf欧宝娱乐app下载地址ony 6.2(当前的稳定版本)。
创建和发送通知
5.0
通知组件是在Symfony 5.0中引入的。欧宝娱乐app下载地址
安装
当前的web应用程序使用许多不同的渠道向用户发送消息(例如短信,松弛消息、邮件推送通知,等等)。Symfony的通知组件是一个抽象的所有这些渠道。欧宝娱乐app下载地址它提供了一个动态的方式来管理消息被发送。得到通知安装使用:
1
美元作曲家需要symfony /通知欧宝娱乐app下载地址
通道:聊天、发短信、电子邮件和浏览器
不同的渠道通知组件可以发送通知。每个通道可以集成不同的提供者(例如松弛或为什么Twilio SMS)通过使用传输。
通知组件支持以下渠道:
- 短信通道通过短信将通知发送到手机;
- 聊天频道将通知发送给聊天服务,如松弛和电报;
- 电子邮件渠道整合了欧宝娱乐app下载地址Symfony梅勒;
- 浏览器通道使用flash的消息。
提示
使用秘密安全地存储你的API的令牌。
短信通道
短信通道使用每人类发送短信到手机。该功能需要订阅一个第三方服务,发送短信。欧宝娱乐app下载地址Symfony提供了集成几个流行的短信服务:
服务 | 包 | DSN |
---|---|---|
AllMySms | 欧宝娱乐app下载地址symfony / allmysms-notifier |
allmysms: / /登录:APIKEY@default ?从= |
Clickatell | 欧宝娱乐app下载地址symfony / clickatell-notifier |
clickatell: / / ACCESS_TOKEN@default ?从= |
Esendex | 欧宝娱乐app下载地址symfony / esendex-notifier |
esendex: / / USER_NAME: PASSWORD@default ? accountreference = ACCOUNT_REFERENCE&from = |
FakeSms | 欧宝娱乐app下载地址symfony / fake-sms-notifier |
fakesms +电子邮件:/ / MAILER_SERVICE_ID ? =, = |
FreeMobile | 欧宝娱乐app下载地址symfony / free-mobile-notifier |
freemobile: / /登录:PASSWORD@default ?电话=电话 |
GatewayApi | 欧宝娱乐app下载地址symfony / gatewayapi-notifier |
gatewayapi: / / TOKEN@default ?从= |
Infobip | 欧宝娱乐app下载地址symfony / infobip-notifier |
infobip: / / AUTH_TOKEN@HOST ?从= |
Iqsms | 欧宝娱乐app下载地址symfony / iqsms-notifier |
iqsms: / /登录:PASSWORD@default ?从= |
LightSms | 欧宝娱乐app下载地址symfony / light-sms-notifier |
lightsms: / /登录:TOKEN@default ? =电话 |
MessageBird | 欧宝娱乐app下载地址symfony / message-bird-notifier |
messagebird: / / TOKEN@default ?从= |
Mobyt | 欧宝娱乐app下载地址symfony / mobyt-notifier |
mobyt: / / USER_KEY: ACCESS_TOKEN@default ?从= |
Nexmo | 欧宝娱乐app下载地址symfony / nexmo-notifier |
nexmo: / /关键:SECRET@default ?从= |
水中曲棍球 | 欧宝娱乐app下载地址symfony / octopush-notifier |
水中曲棍球:/ / USERLOGIN: APIKEY@default ?从=从类型=类型 |
Ovh欧宝体育应用最新版app下载Cloud | 欧宝娱乐app下载地址s欧宝体育应用最新版app下载ymfony / ovh-cloud-notifier |
ovh欧宝体育应用最新版app下载cloud: / / APPLICATION_KEY: APPLICATION_SECRET@default ? consumer_key = CONSUMER_KEY&service_name = SERVICE_NAME |
Sendinblue | 欧宝娱乐app下载地址symfony / sendinblue-notifier |
sendinblue: / / API_KEY@default ?发送方=电话 |
双曲正弦 | 欧宝娱乐app下载地址symfony / sinch-notifier |
双曲正弦:/ / ACCOUNT_ID: AUTH_TOKEN@default ?从= |
Smsapi | 欧宝娱乐app下载地址symfony / smsapi-notifier |
smsapi: / / TOKEN@default ?从= |
SmsBiuras | 欧宝娱乐app下载地址symfony / sms-biuras-notifier |
smsbiuras: / / UID: API_KEY@default ? = FROM&test_mode = 0 |
SpotHit | 欧宝娱乐app下载地址symfony / spothit-notifier |
spothit: / / TOKEN@default ?从= |
为什么Twilio | 欧宝娱乐app下载地址symfony / twilio-notifier |
为什么twilio: / /席德:TOKEN@default ?从= |
5.1
OvhClou欧宝体育应用最新版app下载d,双曲正弦和FreeMobile集成在Symfony 5.1中引入的。欧宝娱乐app下载地址
5.2
Infobip, Smsapi Mobyt, Esendex Sendinblue集成在Symfony 5.2中引入的。欧宝娱乐app下载地址
5.3
Iqsms GatewayApi,水中曲棍球、AllMySms Clickatell, SpotHit, FakeSms, LightSms, SmsBiuras MessageBird集成在Symfony 5.3中引入的。欧宝娱乐app下载地址
使一个人,在你添加正确的DSN.env
文件和配置texter_transports
:
1 2
# .envTWILIO_DSN =为什么twilio: / /席德:TOKEN@default ?从=
- YAML
- XML
- PHP
1 2 3 4 5
#配置/包/ notifier.yaml框架:通知:texter_transports:为什么twilio:' % env (TWILIO_DSN) %
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
< !——配置/包/通知。xml - - >< ?xml version = " 1.0 " encoding = " utf - 8 " ? ><容器xmlns=“http://欧宝娱乐app下载地址www.oldmanjams.com/schema/dic/services”xmlns: xsi=“http://www.w3.org/2001/XMLSchema-instance”xmlns:框架=“http://欧宝娱乐app下载地址www.oldmanjams.com/schema/dic/symfony”xsi: schemaLocation=“http://欧宝娱乐app下载地址www.oldmanjams.com/schema/dic/services //www.oldmanjams.com/schema/dic/services/services-1.0.xsd //www.oldmanjams.com/schema/dic/symfony //www.oldmanjams.com/schema/dic/symfony/symfony-1.0.xsd”><框架:配置><框架:通知><框架:texter-transport的名字=“为什么twilio”>% env (TWILIO_DSN) %< /框架:texter-transport>< /框架:通知>< /框架:配置>< /容器>
1 2 3 4 5 6 7 8
/ /配置/包/ notifier.php使用欧宝娱乐app下载地址\配置\FrameworkConfig;返回静态函数(FrameworkConfig美元框架){美元框架- >通知人()- >texterTransport (“为什么twilio”,' % env (TWILIO_DSN) %);};
聊天频道
聊天频道用于发送聊天消息给用户使用喋喋不休类。欧宝娱乐app下载地址Symfony提供了集成这些聊天服务:
服务 | 包 | DSN |
---|---|---|
不和 | 欧宝娱乐app下载地址symfony / discord-notifier |
不和:/ / TOKEN@default ? webhook_id = ID |
FakeChat | 欧宝娱乐app下载地址symfony / fake-chat-notifier |
fakechat +电子邮件:/ /默认? =,= |
重火力点 | 欧宝娱乐app下载地址symfony / firebase-notifier |
重火力点:/ /用户名:PASSWORD@default |
git | 欧宝娱乐app下载地址symfony / gitter-notifier |
git: / / TOKEN@default ? room_id = room_id |
GoogleChat | 欧宝娱乐app下载地址symfony / google-chat-notifier |
googlechat: / / ACCESS_KEY: ACCESS_TOKEN@default /空间? thread_key = thread_key |
欧宝娱乐app下载地址symfony / linked-in-notifier |
linkedin: / /令牌:USER_ID@default |
|
Mattermost | 欧宝娱乐app下载地址symfony / mattermost-notifier |
mattermost: / / ACCESS_TOKEN@HOST /路径?通道=通道 |
美居酒店 | 欧宝娱乐app下载地址symfony / mercure-notifier |
美居酒店:/ / HUB_ID ?主题=主题 |
MicrosoftTeams | 欧宝娱乐app下载地址symfony / microsoft-teams-notifier |
microsoftteams: / /默认路径 |
RocketChat | 欧宝娱乐app下载地址symfony / rocket-chat-notifier |
rocketchat: / / TOKEN@ENDPOINT ?通道=通道 |
松弛 | 欧宝娱乐app下载地址symfony / slack-notifier |
松:/ / TOKEN@default ?通道=通道 |
电报 | 欧宝娱乐app下载地址symfony / telegram-notifier |
电报:/ / TOKEN@default ? = CHAT_ID频道 |
Zulip | 欧宝娱乐app下载地址symfony / zulip-notifier |
zulip: / /电子邮件:TOKEN@HOST ?通道=通道 |
5.1
重火力点,Mattermost RocketChat集成在Symfony 5.1中引入的。欧宝娱乐app下载地址Symfony 5.1中的松弛DSN改变使用松弛的欧宝娱乐app下载地址人而不是遗产令牌。
5.2
LinkedIn, GoogleChat Zulip和不和集成在Symfony 5.2中引入的。欧宝娱乐app下载地址Symfony 5.2中的松弛DSN改变再次使用松欧宝娱乐app下载地址弛Web API 5.0一样。
5.3
git,水银,FakeChat和微软团队集成在Symfony 5.3中引入的。欧宝娱乐app下载地址
聊天配置使用chatter_transports
设置:
1 2
# .envSLACK_DSN =松弛:/ / TOKEN@default ?通道=通道
- YAML
- XML
- PHP
1 2 3 4 5
#配置/包/ notifier.yaml框架:通知:chatter_transports:松:' % env (SLACK_DSN) %
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18
< !——配置/包/通知。xml - - >< ?xml version = " 1.0 " encoding = " utf - 8 " ? ><容器xmlns=“http://欧宝娱乐app下载地址www.oldmanjams.com/schema/dic/services”xmlns: xsi=“http://www.w3.org/2001/XMLSchema-instance”xmlns:框架=“http://欧宝娱乐app下载地址www.oldmanjams.com/schema/dic/symfony”xsi: schemaLocation=“http://欧宝娱乐app下载地址www.oldmanjams.com/schema/dic/services //www.oldmanjams.com/schema/dic/services/services-1.0.xsd //www.oldmanjams.com/schema/dic/symfony //www.oldmanjams.com/schema/dic/symfony/symfony-1.0.xsd”><框架:配置><框架:通知><框架:chatter-transport的名字=“松弛”>% env (SLACK_DSN) %< /框架:chatter-transport>< /框架:通知>< /框架:配置>< /容器>
1 2 3 4 5 6 7 8
/ /配置/包/ notifier.php使用欧宝娱乐app下载地址\配置\FrameworkConfig;返回静态函数(FrameworkConfig美元框架){美元框架- >通知人()- >chatterTransport (“松弛”,' % env (SLACK_DSN) %);};
电子邮件渠道
电子邮件使用频道欧宝娱乐app下载地址Symfony梅勒使用特殊的发送通知NotificationEmail。应安装树枝桥连同墨色和CSS内联树枝扩展:
1
美元作曲家需要symfony / tw欧宝娱乐app下载地址ig-pack树枝/ cssinliner-extra树枝/ inky-extra
在这之后,配置梅勒。您还可以设置默认”从“应该使用电子邮件地址,发送电子邮件通知:
- YAML
- XML
- PHP
1 2 3 4 5 6
#配置/包/ mailer.yaml框架:梅勒:dsn:' % env (MAILER_DSN) %信封:发送方:“notifications@example.com”
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20
< !——配置/包/梅勒。xml - - >< ?xml version = " 1.0 " encoding = " utf - 8 " ? ><容器xmlns=“http://欧宝娱乐app下载地址www.oldmanjams.com/schema/dic/services”xmlns: xsi=“http://www.w3.org/2001/XMLSchema-instance”xmlns:框架=“http://欧宝娱乐app下载地址www.oldmanjams.com/schema/dic/symfony”xsi: schemaLocation=“http://欧宝娱乐app下载地址www.oldmanjams.com/schema/dic/services //www.oldmanjams.com/schema/dic/services/services-1.0.xsd //www.oldmanjams.com/schema/dic/symfony //www.oldmanjams.com/schema/dic/symfony/symfony-1.0.xsd”><框架:配置><框架:梅勒dsn=“% env (MAILER_DSN) %”><框架:信封发送方=“notifications@example.com”/ >< /框架:梅勒>< /框架:配置>< /容器>
1 2 3 4 5 6 7 8 9 10
/ /配置/包/ mailer.php使用欧宝娱乐app下载地址\配置\FrameworkConfig;返回静态函数(FrameworkConfig美元框架){美元框架- >梅勒()- >dsn (' % env (MAILER_DSN) %)- >信封()- >发送者(“notifications@example.com”);};
配置使用故障转移或循环传输
除了配置一个或多个单独的传输,还可以使用特殊| |
和& &
字符来实现故障转移或循环运输:
- YAML
- XML
- PHP
1 2 3 4 5 6 7 8 9 10
#配置/包/ notifier.yaml框架:通知:chatter_transports:#松弛和使用电报发送通知#松弛错误主要:' % env (SLACK_DSN) % | | % env (TELEGRAM_DSN) % '#发送通知到下一个预定的运输由循环计算设置轮流捡取:' % env (SLACK_DSN) % & & % env (TELEGRAM_DSN) % '
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日
< !——配置/包/通知。xml - - >< ?xml version = " 1.0 " encoding = " utf - 8 " ? ><容器xmlns=“http://欧宝娱乐app下载地址www.oldmanjams.com/schema/dic/services”xmlns: xsi=“http://www.w3.org/2001/XMLSchema-instance”xmlns:框架=“http://欧宝娱乐app下载地址www.oldmanjams.com/schema/dic/symfony”xsi: schemaLocation=“http://欧宝娱乐app下载地址www.oldmanjams.com/schema/dic/services //www.oldmanjams.com/schema/dic/services/services-1.0.xsd //www.oldmanjams.com/schema/dic/symfony //www.oldmanjams.com/schema/dic/symfony/symfony-1.0.xsd”><框架:配置><框架:通知>< !——松弛和使用电报发送通知如果松弛错误- - ><框架:chatter-transport的名字=“松弛”>% env (SLACK_DSN) % | | % env (TELEGRAM_DSN) %< /框架:chatter-transport>< !——发送通知到下一个预定的运输计算循环- - ><框架:chatter-transport的名字=“松弛”>< !(CDATA[ %env(SLACK_DSN)% && %env(TELEGRAM_DSN)% ]]>< /框架:chatter-transport>< /框架:通知>< /框架:配置>< /容器>
1 2 3 4 5 6 7 8 9 10 11 12 13
/ /配置/包/ notifier.php使用欧宝娱乐app下载地址\配置\FrameworkConfig;返回静态函数(FrameworkConfig美元框架){美元框架- >通知人()/ /发送通知松弛和使用电报/ /松弛错误- >chatterTransport (“主要”,' % env (SLACK_DSN) % | | % env (TELEGRAM_DSN) % ')/ /发送通知到下一个预定的运输由循环计算- >chatterTransport (此“循环”,' % env (SLACK_DSN) % & & % env (TELEGRAM_DSN) % ');};
创建和发送通知
发送一个通知,自动装配NotifierInterface(服务标识通知人
)。这个类有send ()
方法允许您发送一个通知到一个收件人:
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 28 29 30 31 32 33
/ / src /控制器/ InvoiceController.php名称空间应用程序\控制器;使用欧宝娱乐app下载地址\组件\通知人\通知\通知;使用欧宝娱乐app下载地址\组件\通知人\NotifierInterface;使用欧宝娱乐app下载地址\组件\通知人\收件人\收件人;类InvoiceController扩展AbstractController{/ * * *@Route(“/发票/创建”)* /公共函数创建(NotifierInterface美元通知人){/ /……/ /创建一个发送通知/ /使用“邮件”频道美元通知= (新通知(“新发票”,(“电子邮件”)))- >内容(“你有一个新的发票15欧元。”);/ /接收方的通知美元收件人=新收件人(美元用户- >getEmail (),美元用户- >getPhonenumber ());/ /发送通知收件人美元通知人- >发送(美元通知,美元收件人);/ /……}}
的通知
通过使用两个参数:创建主题和渠道。通道指定哪个频道(或运输)应该用于发送通知。例如,(“电子邮件”、“短信”)
将发送电子邮件和短信通知给用户。
也有一个默认的通知内容()
和emoji ()
方法设置通知内容和图标。
欧宝娱乐app下载地址Symfony提供了以下收件人:
- NoRecipient
- 这是默认的,没有必要时是有用的信息接收器。例如,浏览器通道使用当前的请求会话flashbag;
- 收件人
- 这既可以包含用户的电子邮件地址和电话号码。这个收件人可以用于所有渠道(取决于他们是否实际上是集)。
5.2
的AdminRecipient
类被在Symfony 5.2中,您应该使用欧宝娱乐app下载地址收件人
代替。
配置渠道政策
而不是指定目标创建频道,Symfony还允许您使用通知重要性水平。欧宝娱乐app下载地址更新的配置来指定应该使用哪些渠道(使用特定的水平channel_policy
):
- YAML
- XML
- PHP
1 2 3 4 5 6 7 8 9 10 11 12 13 14
#配置/包/ notifier.yaml框架:通知:#……channel_policy:#使用短信,松弛和电子邮件紧急通知紧急:(“短信”,“聊天/松弛”,“电子邮件”]#使用松弛非常重要的通知高:(“聊天/松弛”)#使用浏览器中、低通知介质:(“浏览器”)低:(“浏览器”)
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 28 29 30
< !——配置/包/通知。xml - - >< ?xml version = " 1.0 " encoding = " utf - 8 " ? ><容器xmlns=“http://欧宝娱乐app下载地址www.oldmanjams.com/schema/dic/services”xmlns: xsi=“http://www.w3.org/2001/XMLSchema-instance”xmlns:框架=“http://欧宝娱乐app下载地址www.oldmanjams.com/schema/dic/symfony”xsi: schemaLocation=“http://欧宝娱乐app下载地址www.oldmanjams.com/schema/dic/services //www.oldmanjams.com/schema/dic/services/services-1.0.xsd //www.oldmanjams.com/schema/dic/symfony //www.oldmanjams.com/schema/dic/symfony/symfony-1.0.xsd”><框架:配置><框架:通知>< !——……- - ><框架:channel-policy>< !——使用短信、松弛和紧急通知的电子邮件- - ><框架:紧急>短信< /框架:紧急><框架:紧急>聊天/松弛< /框架:紧急><框架:紧急>电子邮件< /框架:紧急>< !——使用缺口高度重要的通知><框架:高>聊天/松弛< /框架:高>< !——使用浏览器中、低通知><框架:中等>浏览器< /框架:中等><框架:低>浏览器< /框架:低>< /框架:channel-policy>< /框架:通知>< /框架:配置>< /容器>
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15
/ /配置/包/ notifier.php使用欧宝娱乐app下载地址\配置\FrameworkConfig;返回静态函数(FrameworkConfig美元框架){/ /……美元框架- >通知人()/ /使用短信,松弛和电子邮件紧急通知- >channelPolicy (“紧急”,(“短信”,“聊天/松弛”,“电子邮件”])/ /使用松弛非常重要的通知- >channelPolicy (“高”,(“聊天/松弛”])/ /使用浏览器中、低通知- >channelPolicy (“媒介”,(“浏览器”])- >channelPolicy (“媒介”,(“浏览器”]);};
现在,每当通知的重要性设置为“高”,它将使用松弛运输:
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19
/ /……类InvoiceController扩展AbstractController{/ * * *@Route(“/发票/创建”)* /公共函数发票(NotifierInterface美元通知人){/ /……美元通知= (新通知(“新发票”))- >内容(“你有一个新的发票15欧元。”)- >重要性(通知::IMPORTANCE_HIGH);美元通知人- >发送(美元通知,新收件人(“wouter@example.com”));/ /……}}
自定义通知
您可以扩展通知
或收件人
基类来定制他们的行为。例如,您可以覆盖getChannels ()
方法只返回短信
如果发票价格是非常高的,收件人电话号码:
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
名称空间应用程序\通知人;使用欧宝娱乐app下载地址\组件\通知人\通知\通知;使用欧宝娱乐app下载地址\组件\通知人\收件人\RecipientInterface;使用欧宝娱乐app下载地址\组件\通知人\收件人\SmsRecipientInterface;类InvoiceNotification扩展通知{私人美元价格;公共函数__construct(int美元价格){美元这- >价格=美元价格;}公共函数getChannels(RecipientInterface美元收件人){如果(美元这- >价格>10000年& &美元收件人运算符SmsRecipientInterface) {返回(“短信”];}返回(“电子邮件”];}}
自定义通知消息
每个通道都有自己的通知接口,可以实现自定义通知消息。例如,如果您想修改消息聊天服务的基础上,实现ChatNotificationInterface和它的asChatMessage ()
方法:
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 28 29 30
/ / src /通知/ InvoiceNotification.php名称空间应用程序\通知人;使用欧宝娱乐app下载地址\组件\通知人\消息\ChatMessage;使用欧宝娱乐app下载地址\组件\通知人\通知\ChatNotificationInterface;使用欧宝娱乐app下载地址\组件\通知人\通知\通知;使用欧宝娱乐app下载地址\组件\通知人\收件人\SmsRecipientInterface;类InvoiceNotification扩展通知实现了ChatNotificationInterface{私人美元价格;公共函数__construct(int美元价格){美元这- >价格=美元价格;}公共函数asChatMessage(RecipientInterface美元收件人、字符串美元运输= null):哦?ChatMessage{/ /添加一个自定义emoji如果消息被发送到松弛如果(“松弛”= = =美元运输){返回(新ChatMessage (“你\ ' re发票”。美元这- >价格。“欧元”。))- >emoji (“钱”);}/ /如果你返回null,将创建ChatMessage通知/ /根据这个通知也没有这种方法。返回零;}}
的SmsNotificationInterface和EmailNotificationInterface也存在修改发送的消息渠道。
禁用交付
在开发(或测试),你可能想要完全禁用的交付通知。你可以通过迫使通知使用NullTransport
配置为所有人,只在喋喋不休传输dev
(和/或测试
)环境:
1 2 3 4 5 6 7
#配置/包/ dev / notifier.yaml框架:通知:texter_transports:为什么twilio:“零:/ /空”chatter_transports:松:“零:/ /空”
- . .待办事项
-
- 使用异步通知的消息总线
- 描述通知独白处理程序
- 描述notification_on_failed_messages集成