amiriskander / slack-notifier
一个简单的包,可用于构建和发送Slack消息
v2.1.0
2022-02-13 10:54 UTC
Requires
- php: >=7.1
- ext-curl: *
- ext-json: *
README
一个简单的PHP包,可用于构建和发送Slack消息
要求
- PHP >= 7.1
- PHP cURL 扩展
- PHP JSON 扩展
安装
composer require amiriskander/slack-notifier
使用方法
创建一个简单的文本消息,如 Hello, World!
,无需大量努力
use AmirIskander\SlackNotifier;
public function TestHelloWorld()
{
$message = new Message()
->addBlock(new Section()->setText(new PlainText('Hello, World!')));
->send('https://hooks.slack.com/services/....')
;
}
该包支持块类型
- 分隔符:一个灰色的水平分隔符。
- 部分:可以包含多个组件的容器。
并且一个部分类型的块可以包含以下类型的组件
- 文本:可以是
纯文本
或Markdown
- 附件:可以是
按钮
或图片
对于需要添加带有图片、链接和按钮的块更复杂示例,这不是什么大问题。请查看以下示例
use AmirIskander\SlackNotifier;
public function TestSendSlackMessage()
{
$message = new Message();
$block = new Block('section');
$block->setText(new Text('mrkdwn', 'John Doe submitted a feedback!'));
$message->addBlock($block);
$block = new Block('divider');
$message->addBlock($block);
$block = new Block('section');
$block->setText(new Text('mrkdwn', ':new: *You guys are awesome. Keep up the good work!*'));
$message->addBlock($block);
$block = new Block('section');
$block->setText(new Text('mrkdwn', '*Source* :information_source: Homepage Feedback Form'));
$message->addBlock($block);
$block = new Block('section');
$block->setText(new Text('mrkdwn', '*In the last 30 days*'));
$block->addField(new Text('mrkdwn', 'Submitted 6 form submissions'));
$block->addField(new Text('mrkdwn', 'Rated 12 products'));
$accessory = new Accessory('image');
$accessory->setImageUrl('https://i.ibb.co/19W2sdD/stat.png');
$accessory->setAltText('Stats');
$block->setAccessory($accessory);
$message->addBlock($block);
$block = new Block('divider');
$message->addBlock($block);
$block = new Block('section');
$block->setText(new Text('mrkdwn', 'More information about this user'));
$accessory = new Accessory('button');
$accessory->setUrl('https://yourwebsite/user/123/profile/');
$accessory->setText(new Text('plain_text', ':bust_in_silhouette: View User'));
$accessory->setValue('view_user_btn');
$block->setAccessory($accessory);
$message->addBlock($block);
// Replace parameter below with webhook of channel you would like to post to
$message->send('https://hooks.slack.com/services/....');
}
使用类为按钮、图片、部分、分隔符创建的相同示例
use AmirIskander\SlackNotifier;
public function TestSendSlackMessage()
{
// Init Message object
$message = new Message();
// Adding a section
$block = new Section();
$block->setText(new MarkdownText('John Doe submitted a feedback!'));
$message->addBlock($block);
// Adding a divider
$message->addBlock(new Divider());
$block = new Section();
$block->setText(new MarkdownText(':new: *You guys are awesome. Keep up the good work!*'));
$message->addBlock($block);
$block = new Section();
$block->setText(new MarkdownText('*Source* :information_source: Homepage Feedback Form'));
$message->addBlock($block);
$block = new Section();
$block->setText(new MarkdownText('*In the last 30 days*'));
$block->addField(new MarkdownText('Submitted 6 form submissions'));
$block->addField(new MarkdownText('Rated 12 products'));
$accessory = new Image('https://i.ibb.co/19W2sdD/stat.png', 'Stats');
$block->setAccessory($accessory);
$message->addBlock($block);
$message->addBlock(new Divider());
$block = new Section();
$block->setText(new MarkdownText('More information about this user'));
$block->setAccessory(new Button(
'https://yourwebsite/user/123/profile/',
':bust_in_silhouette: View User'
));
$message->addBlock($block);
// Replace parameter below with webhook of channel you would like to post to
$message->send('https://hooks.slack.com/services/....');
}