Clash of Clans API 结果的抽象层

0.0.1-beta 2016-02-15 21:49 UTC

This package is not auto-updated.

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


README

简介

COCUrl 是一个 PHP 框架,旨在使与 Clash of Clans 开发者 API 的交互更加容易。它创建了一个面向对象的层,位于原始 cURL 请求之上,并提供 CoC API 返回的常见类型的对象和枚举。发送请求就像在对象上调用一些函数一样简单。

安装

目前支持通过 composer 安装。只需将以下行添加到项目目录内 composer.json 文件中的 require 键下。

"require": {
  "snowiow/cocurl": "dev-master"
}

您也可以使用任何指定的版本,而不是 dev-master。更多信息请访问composer 网站

如何使用?

一切从 Client 类开始。它需要一个 API 密钥来创建。

$client = COCUrl\Client('my-api-key');

使用 $client 实例,您能够执行 CoC API 测试版中提供的所有调用。所有调用都以函数调用的形式进行。例如,如果我们想检索所有位置,我们可以这样做

$client = COCUrl\Client('my-api-key');
$locations = $client->locations();

$locations 是一个包含位置对象的数组。所有数据都作为公共属性提供。例如,我们可以通过执行以下行来获取我们找到的第一个位置的名字

$locations[0]->name; 

如果您想在同一 URL 下进行特殊请求,这也通过相同的方法实现。这通常是通过标准参数实现的。这种行为贯穿了整个 COCUrl 框架。例如,如果您知道您要检索的位置 ID。调用将如下所示

$location = $client->locations(32000094); //Returns a Location object of Germany
echo $location->name; //Would print Germany

有关当前实现完整参考的信息,请参阅ClientTest 类