README

pronoundb.org API 的 API 包装器。

设置

您需要创建一个客户端才能使用 pronoundb 包装器。请确保使用一个 描述性的用户代理。

use Steffospieler\PronounDB\Client;

$client = new Client("Example for PHP PronounDB API Wrapper");

示例

通过 Discord ID 查找某人的代词

use Steffospieler\PronounDB\Client;
use Steffospieler\PronounDB\Platform;

$client = new Client("Example for PHP PronounDB API Wrapper");
$client->getPronounsByPlatformIds(Platform::Discord, 123456789012345678);
# -> {123456789012345678: ["he", "him"]}

通过 Minecraft (Java) UUID 查找某人的代词

use Steffospieler\PronounDB\Client;
use Steffospieler\PronounDB\Platform;

$client = new Client("Example for PHP PronounDB API Wrapper");
$client->getPronounsByPlatformIds(Platform::Minecraft, "12345678-1234-1234-1234-123456789012")
# -> {"12345678-1234-1234-1234-123456789012": ["they", "them"]}

通过 Discord ID 查找多个用户的代词

use Steffospieler\PronounDB\Client;
use Steffospieler\PronounDB\Platform;

$client = new Client("Example for PHP PronounDB API Wrapper");
$client->getPronounsByPlatformIds(Platform::Discord, [123456789012345678, 987654321098765432])
# -> {123456789012345678: ["he", "him"], 987654321098765432: ["she", "her"]}

支持的平台

• Discord
• GitHub
• Minecraft (Java)
• Twitch
• Twitter

自定义代词

您可以为客户端提供一个代词列表以进行翻译。

use Steffospieler\PronounDB\Client;
use Steffospieler\PronounDB\Platform;

$client = new Client("Example for PHP PronounDB API Wrapper", [
    "unspecified" => [],
    "he" => ["Er", "Ihn"],
    "she" => ["Sie", "Ihr"],
    "it" => ["Es", "Seine"],
    "they" => ["They", "Them"],
    "any" => ["Jede"],
    "other" => ["Anderes"],
    "ask" => ["Frag"],
    "avoid" => ["Nutz Name"],
]);

$client->getPronounsByPlatformIds(Platform::Discord, 123456789012345678);
# -> {123456789012345678: ["Er", "Ihn"]}

您还可以使用其中包含的翻译代词（Translations::EnglishPronouns 和 Translations::GermanPronouns）。当 forgejo 支持时，您还可以贡献翻译！ :D

⚠️ 注意，目前在一些语言中，某些翻译（如 "They/Them"）仍然在积极讨论如何翻译，因此，亲爱的开发者：请考虑预设的方式是否合适。

• 如果合适，忽略弃用警告并使用预设。
• 如果不合适，请自己制作。

装饰

装饰是 pronoundb 的新功能，目前处于测试阶段。如果您想使用它们，可以这样做

use Steffospieler\PronounDB\Client;
use Steffospieler\PronounDB\Platform;

$client = new Client("Example for PHP PronounDB API Wrapper");
$client->getDecorationsByPlatformIds(Platform::Discord, 123456789012345678)
# -> {123456789012345678: "donator_aurora"}

贡献

欢迎并强烈鼓励对该库的贡献。

许可

该项目受 MIT 许可证许可 - 有关详细信息，请参阅 LICENSE 文件。