fisk / steamrep
steamrep.com 网页 API 封装器
Requires
- php: ^7.1 || ^8.0
- ext-json: *
- guzzlehttp/guzzle: ~6.1
Requires (Dev)
- phpunit/phpunit: ^9.4
README
提供绑定以访问公共 SteamRep 网页 API,以获取用户的声誉。
Composer
composer require fisk/steamrep
用法
典型用法如下
<?php
use SteamRep\SteamRep;
$client = new SteamRep();
$response = $client->getUser("76561197971691194");
$tags = $response->getReputation()->getTags();
foreach ($tags as $tag) {
print("{$tag->getAuthority()} {$tag->getStatus()}\n"); // SR ADMIN
}
SteamRepResponse
SteamRepResponse
是成功调用的响应对象。
isValid(): bool
虽然对 SteamRep API 的调用可能成功,但输入的 SteamId64 可能不正确,或者指的是 SteamRep 上尚未跟踪的配置文件。
这断言 steamrep.flags.status
的值为 valid
。
getLastSyncTime(): int
获取 SteamRep 配置文件的最后更新时间。
getReputation(): Reputation
返回一个 Reputation
实体,它提供了 steamrep.reputation
文档的辅助函数。
getStats(): Stats
返回一个 Stats
实体,它提供了 steamrep.stats
文档的辅助函数。
Reputation
Reputation
类公开了用户的声誉数据。
getSummary(): string
返回 steamrep.reputation.summary
提供的值。已知值如下
none
SCAMMER
CAUTION
ADMIN
MIDDLEMAN
TRUSTED SELLER
(已弃用)
getTagString(): string
由 steamrep.reputation.full
提供的标签名分隔列表。
标签字符串中的标签按标签类别排序,杂项标签最后出现。
getTags(): Tag[]
返回表示 steamrep.reputation.tags
文档的 Tag
对象数组。
此数组中的标签按时间顺序排序。
Tag
一个 Tag
表示一个 SteamRep 标签,它由一个权限和一个状态组成。此库提供了一些辅助方法来提取此信息。
getName(): string
获取此标签的名称,例如 SOP ADMIN
getAuthority(): string
获取此标签的权限,例如 SOP
getStatus(): string
获取此标签的状态,例如 ADMIN
getTimestamp(): int
获取标签的创建时间作为 UNIX 时间戳。
getDateTime(): DateTime
获取标签的创建时间作为 PHP DateTime
对象。
注意:SteamRep API 提供了一个日期字符串,但该字符串不包括时区。如果需要“SteamRep 时间”,请将返回的对象的时区设置为 CST6CDT。
getCategory(): string
获取标签的类别。这可以是以下之一
trusted
- 表示受信任的用户组;合作伙伴社区、中间人、SteamRep 管理员等。misc
- 用于 SteamRep 捐赠者标签。evil
- 欺诈者标签。warning
- 警告标签。
Stats
getBannedFriendsCount(): int
返回带有 SCAMMER 标签的朋友数量。
getUnconfirmedReportsCount(): int
返回未确认报告的数量(具有非结论性标签的论坛帖子的数量)。
错误处理
-
客户端将抛出
GuzzleException
以处理 Guzzle 客户端错误,或者如果返回的数据格式不正确,将抛出SteamRepException
。 -
如果您不确定输入,请始终检查
SteamRepResponse
的isFound()
方法。如果请求的 SteamID64 是有效的,则这将返回 true。