kolter / plol
英雄联盟API的PHP接口包装器
v1.0.0
2016-03-26 17:53 UTC
Requires
- php: ^5.5.9
- guzzlehttp/guzzle: ~6.0
- symfony/yaml: 3.0.1
- tedivm/stash: ^0.14
This package is not auto-updated.
Last update: 2024-09-20 18:12:19 UTC
README
PLoL是一个PHP API,旨在通过简化英雄联盟API来简化操作。主要目标是增加灵活性和可扩展性。它实现了缓存系统和速率限制处理器,自定义输出模式,自定义错误代码处理器。
使用的库
- guzzlehttp/guzzle 处理请求
- tedivm/stash 处理缓存系统
- symfony/yaml 在输出模式类中使用,以yaml格式输出结果
如何安装
使用 Composer
composer require "kolter/plol" dev-master
composer.json
"require":
{
"kolter/plol":"dev-master"
}
配置
首先,获取您的英雄联盟API密钥。您将需要此API密钥来实例化资源。在config/config.json文件夹中,有一些可能需要更改的参数
有一些默认选项您可能需要考虑更改
- cache: true表示资源将被缓存,false则不会。
- region: API的默认区域。(检查区域缩写)
基本API使用
此库使用PSR-4实现的命名空间。基本实现
<?php use Kolter\PLoL\Resources\Game; include('path/to/vendor/autoload.php'); $game = new Game("{YOUR API KEY HERE}"); echo $game->get(1245678);
这是基本用法,您将获得json格式的结果(默认)。您可以在一个指定的实例中设置一些选项。
$game = (new Game("{YOUR API KEY HERE}"))->setCache(false) ->setOutputMode(ObjectOutput()); $game->get(1245678)->games->fellowPlayers[0]->teamId;
有关更多信息,请参阅ResourceRequest类API。
结构
资源是您可以在英雄联盟API中获取的内容。以下是一些不同的资源及其用法示例。
ResourceHandler
每个资源类都从此扩展。这里是核心。
英雄
获取特定英雄的信息
特色游戏
获取当前游戏的信息。
游戏
获取当前游戏的信息。
联盟
获取当前游戏的信息。