baerserk/coc-api-php

PHP 封装库,用于查询 Supercell 的部落冲突 API

dev-main 2024-05-20 17:00 UTC

This package is auto-updated.

Last update: 2024-09-20 17:58:10 UTC


README

轻松查询 Supercell 的部落冲突 API 数据!此包使用官方 API。更多信息,请访问 https://developers.clashofclans.com

此包已在 PHP 5.5 及以上版本进行测试并正常工作,包括 PHP 7.0!

请注意,由于尚无稳定版本发布,API 可能随时更改。

要求

使用此包,您需要从 https://developer.clashofclans.com 获取 API 密钥

安装

使用 Composer

composer require baerserk/coc-api-php

使用方法

实例化客户端时,您必须提供 API 密钥

$client = new Client('API_KEY_HERE');

部落

参考官方文档中的 /clans 端点。

您可以使用官方文档中指定的任何参数作为键,将值作为参数值,同理

$client->getClans(['name' => 'Foo', 'minMembers' => 30]); // returns array of Clan objects

提示:如果您只按部落名称搜索,无需指定数组作为参数,只需一个简单的字符串即可

$client->getClans('Foo'); // returns array of Clan objects

有关所有可用参数,请浏览 官方文档

通过标签获取特定部落

参考官方文档中的 /clans/{clanTag} 端点。

使用非常简单

$clan = $client->getClan('#2VP0J0VV'); // returns Clan object

$clan->name(); // "Hattrickers"
$clan->level(); // 8
$clan->warWins(); // 168

有关更多可用方法,请访问 ClashOfClans\Api\Clan\Clan 类。

获取领袖信息

$leader = $clan->memberList()->leader(); // returns Player
$leader->name(); // "VanSilent"
$leader->donations(); // 3451
$leader->expLevel(); // 118
$leader->trophies(); // 2548

有关更多可用方法,请访问 ClashOfClans\Api\Clan\Player 类。

获取共同领袖和长老

$coLeaders = $clan->memberList()->coLeaders(); // array of Player objects
$elders = $clan->memberList()->elders(); // array of Player objects

联盟

参考官方文档中的 /leagues 端点。

$leagues = $client->getLeagues(); // returns array of League objects

$leagues[0]->id(); // 29000001
$leagues[0]->name(); // Bronze League III

位置

参考官方文档中的 /locations 端点。

获取所有可用位置非常简单

$client->getLocations(); // returns array of Location objects

通过 ID 获取特定位置

参考官方文档中的 /locations/{locationId} 端点。

$location = $client->getLocation(32000066); // returns Location object

$location->name(); // Croatia
$location->countryCode(); // HR
$location->isCountry(); // true

获取特定位置的排名

参考官方文档中的 /locations/{locationId}/rankings/{rankingId} 端点。

$rankings = $client->getRankingsForLocation($locationId, 'clans'); // returns array of Clan objects

// top clan
$rankings[0]->name(); // Foobar
$rankings[0]->trophies(); // 47846

除了 'clans' 外,您还可以将字符串 players 作为第二个参数传递,这将返回玩家对象的数组。