README

这是一个为PHP客户端提供的Slack API客户端，支持使用Websocket实现的实时消息API（RTM API）。

概述

这个库最初是为Slackyboy创建的，但后来分支成为一个独立的代码库，以便在其他项目中使用。我创建这个客户端是因为现有的客户端要么使用起来太复杂，要么有bug，要么不完整。这也是我所知第一个支持Slack RTM API的PHP客户端。

安装

使用Composer安装，这是显而易见的

$ composer require mpociot/slack-client

请注意，当前版本有不稳定的依赖项。

为了安装这些依赖项，您可以在您的composer.json中设置"minimum-stability"，并建议您设置"prefer-stable"

{
    "minimum-stability": "dev",
    "prefer-stable": true
}

用法

首先，您需要创建一个客户端对象以连接到Slack服务器。您首先需要从Slack获取您的应用的API令牌，然后将令牌传递给客户端对象进行登录。由于这个库使用React，您还必须传递一个事件循环对象

$loop = \React\EventLoop\Factory::create();

$client = new \Slack\ApiClient($loop);
$client->setToken('YOUR-TOKEN-HERE');
// ...
$loop->run();

假设您的令牌有效，您就可以开始使用了！您现在可以使用包装器方法来访问大多数Slack API。下面是一个将消息发布到通道的示例

$client->getChannelById('C025YTX9D')->then(function (\Slack\Channel $channel) use ($client) {
    $client->send('Hello from PHP!', $channel);
});

高级消息

Slack支持比纯文本更丰富的消息，通过附件来实现。创建自定义消息的最简单方法是使用MessageBuilder

use Slack\Message\{Attachment, AttachmentField};

$message = $client->getMessageBuilder()
    ->setText('Hello, all!')
    ->setChannel($someChannelObject)
    ->addAttachment(new Attachment('My Attachment', 'attachment text'))
    ->addAttachment(new Attachment('Build Status', 'Build failed! :/', 'build failed', 'danger')))
    ->addAttachment(new Attachment('Some Fields', 'fields', null, '#BADA55', [
        new AttachmentField('Title1', 'Text', false),
        new AttachmentField('Title2', 'Some other text', true)
    ]))
    ->create();

$client->postMessage($message);

请参阅API文档以获取消息、附件和字段支持的所有方法和属性的列表。

异步请求和承诺

所有客户端请求都使用React承诺异步执行。因此，大多数客户端方法返回承诺。这使得您能够轻松地组合请求顺序并按需处理它们。由于它使用React，请务必调用$loop->run()，否则请求不会被发送。

React允许客户端在请求时表现良好，并防止阻塞整个线程。这对于编写实时应用程序，如Slack聊天机器人非常有用。

实时消息API

您还可以使用实时消息API连接到Slack。这对于创建Slack机器人或消息客户端非常有用。实时客户端类似于常规客户端，但它允许实时接收事件。首先，您需要创建客户端

$client = new \Slack\RealTimeClient();
$client->setToken('YOUR-TOKEN-HERE');
$client->connect();

然后您可以像平常一样使用客户端；RealTimeClient扩展了ApiClient，并具有相同的API用于发送请求。您可以使用RealTimeClient::on()将回调附加到处理传入的Slack事件

$client->on('file_created', function($data) {
    echo 'A file was created called ' . $data['file']['name'] . '!\n';
});

下面是一个非常简单、完整的示例

$loop = React\EventLoop\Factory::create();

$client = new Slack\RealTimeClient($loop);
$client->setToken('YOUR-TOKEN-HERE');

// disconnect after first message
$client->on('message', function ($data) use ($client) {
    echo "Someone typed a message: ".$data['text']."\n";
    $client->disconnect();
});

$client->connect()->then(function () {
    echo "Connected!\n";
});

$loop->run();

请参阅Slack API文档以获取可能的事件的列表。

文档

您可以在这里查看完整的API文档。

运行测试

在安装依赖后，您可以使用PHPUnit 运行自动化单元测试。

$ vendor/bin/phpunit

获取帮助的途径

需要帮助？请将包含您问题的电子邮件发送给我。请确保在邮件主题行中添加“Slack客户端”，这样我知道如何帮助您。

许可证

本库采用MIT许可证。有关详细信息，请参阅LICENSE文件。