README

Yasmin 是一个用于 PHP 的 Discord API 库。Yasmin 连接到网关并与 REST API 交互。

请注意，此库仅适用于 PHP 7.1（及以上版本）并在 CLI 中使用。Yasmin 只支持机器人账户。

开始之前

在开始使用此库之前，您需要了解 PHP 的工作原理，您需要了解该语言，并且您需要了解事件循环和承诺的工作原理。这是您开始之前的基本要求。如果没有这些知识，您只会受苦。

请参阅 https://github.com/elazar/asynchronous-php 获取资源。

入门

使用 Yasmin 入门非常简单。您需要做的就是使用 composer 安装 Yasmin 及其依赖项。然后，您可以将 composer 的自动加载器包含到您的文件中，并开始与 Discord 和 Yasmin 交互！

composer require sylae/yasmin

重要的是要监听 error 事件。如果您没有附加 error 监听器，事件发射器将抛出异常。

请确保您还有所有承诺的拒绝处理器，因为未处理的承诺拒绝将被吞没，您将永远不知道它们发生了什么。

重要信息：类实例上所有使用魔法方法实现的属性（这意味着几乎所有的属性），如果属性不存在，将抛出异常。

有一个 WIP Gitbook，其中包含一些提示，您可以自由阅读： https://charlottedunois.gitbooks.io/yasmin-guide/content/

示例

这是一个使用 Yasmin 的简单示例。您应该将所有监听器代码放入 try-catch 块中，并相应地处理异常。

// Include composer autoloader

$loop = \React\EventLoop\Factory::create();
$client = new \CharlotteDunois\Yasmin\Client(array(), $loop);

$client->on('error', function ($error) {
    echo $error.PHP_EOL;
});

$client->on('ready', function () use ($client) {
    echo 'Logged in as '.$client->user->tag.' created on '.$client->user->createdAt->format('d.m.Y H:i:s').PHP_EOL;
});

$client->on('message', function ($message) {
    echo 'Received Message from '.$message->author->tag.' in '.($message->channel instanceof \CharlotteDunois\Yasmin\Interfaces\DMChannelInterface ? 'DM' : 'channel #'.$message->channel->name ).' with '.$message->attachments->count().' attachment(s) and '.\count($message->embeds).' embed(s)'.PHP_EOL;
});

$client->login('YOUR_TOKEN')->done();
$loop->run();

语音支持

没有语音支持。

文档

https://sylae.github.io/Yasmin/

Windows 和 SSL

遗憾的是，PHP 在 Windows 上无法访问 Windows 证书存储。这是一个问题，因为 TLS 被使用，因此证书验证被应用（关闭此选项是不可行的）。

您将通过脚本在没有任何错误的情况下立即退出一个循环来注意到这个问题。遗憾的是，由于某种原因，没有错误或异常。

因此，此库的用户需要从 cURL 网站下载证书颁发机构提取。
必须将 caextract 的路径设置在 php.ini 的 openssl.cafile 中。