testmonitor / teams-client
TestMonitor Teams客户端。
v2.0.0
2024-04-10 10:47 UTC
Requires
- php: ^8.1
- sebbmeyer/php-microsoft-teams-connector: ^0.2.2
Requires (Dev)
- friendsofphp/php-cs-fixer: ^3.0
- mockery/mockery: ^1.4
- phpunit/phpunit: ^10.0
- scrutinizer/ocular: ^1.9
- squizlabs/php_codesniffer: ^3.7
README
此软件包提供了一个基于入站webhook向Microsoft Teams发送消息的基本、便捷和统一的包装器。
它主要基于Sebastian Bretschneider的PHP Microsoft Teams Connector,但使用Guzzle而不是PHP CURL扩展。此软件包公开了PHP Microsoft Teams Connector中的优秀Card对象,可以使用流畅的PHP语法构建各种消息。
目录
安装
要安装客户端,您需要使用composer引入该软件包
$ composer require testmonitor/teams-client
使用composer的自动加载
require __DIR__.'/../vendor/autoload.php';
现在您已经设置好了!
用法
在您能够发布消息之前,您需要在Teams中设置入站webhook
- 启动Microsoft Teams应用程序。
- 选择Teams标签页。
- 选择一个团队。
- 在您想要消息送达的频道上右键单击,然后选择连接器。
- 选择"入站webhook"连接器,然后点击添加。
- 为您的webhook提供名称,并可选地提供徽标。
- 点击创建,您的webhook URL将提供。
使用webhook URL创建新的客户端实例
$teams = new \TestMonitor\Teams\Client('https://webhook.url/');
示例
向Teams发布简单消息
$card = new \TestMonitor\Teams\Resources\SimpleCard([ 'title' => 'Some title', 'text' => 'Hello World!', ]); $teams->postMessage($card);
内置连接器软件包允许发送更全面的消息。以下是一个示例
$user = (object) ['name' => 'John Doe']; $card = new \TestMonitor\Teams\Resources\CustomCard('New Issue', "{$user->name} created a new issue"); $card->setColor('7FB11B') ->addFacts('Issue **I365**', [ 'Status' => '**Open**', 'Priority' => '**High**', 'Resolution' => '**Unresolved**', ]) ->addAction('Open in TestMonitor', 'https://www.testmonitor.com/'); $teams->postMessage($card);
有关如何构建这些消息的更多信息,请参阅PHP Microsoft Teams Connector的更多示例,或参考微软的构建卡片和任务模块文档。
测试
该软件包包含集成测试。您可以使用PHPUnit运行它们。
$ vendor/bin/phpunit
变更日志
有关更多信息,请参阅CHANGELOG。
贡献
有关贡献详情,请参阅CONTRIBUTING。
致谢
- Thijs Kok - 主要开发者 - ThijsKok
- Stephan Grootveld - 开发者 - Stefanius
- Frank Keulen - 开发者 - FrankIsGek
- Muriel Nooder - 开发者 - ThaNoodle
许可证
MIT许可证(MIT)。有关更多信息,请参阅许可证。