library plol

kolter/plol

PHP interface wrapper to the League of Legends API

PLoL

, _(*1)

PLoL is a PHP API that tries to simplify with the League of Legends API The main focus is to add versability and scalability. It implements a cache system and a rate limiter handler, custom output modes, custom error codes handler., _(*2)

Libraries used

• guzzlehttp/guzzle to handle requests
• tedivm/stash to handle the cache system
• symfony/yaml in a Output mode class to output results in yaml

How to install

Using Composer, _(*3)

composer require "kolter/plol" dev-master

composer.json, _(*4)

"require":
{
"kolter/plol":"dev-master"
}

Configuration

First of all, get your League of Legends API KEY. You will need this api key to instance resources. In the config/config.json folder there are some parameters you may want to change:, _(*5)

There are some default options that you may consider change:, _(*6)

• cache: true means resources will be cached, false won't.
• region: default region to the api. (check regions acronym)

Basic Api Usage

This library use the PSR-4 implementation of namespaces. Basic implementation: ``` php <?php use Kolter\PLoL\Resources\Game;, _(*7)

include('path/to/vendor/autoload.php');, _(*8)

$game = new Game("{YOUR API KEY HERE}"); echo $game->get(1245678);, _(*9)

This is basic usage, you will get the result in json (by default). you can set some option in one specified instance.

``` php
$game = (new Game("{YOUR API KEY HERE}"))->setCache(false)
->setOutputMode(ObjectOutput());
$game->get(1245678)->games->fellowPlayers[0]->teamId;

Take a look at the ResourceRequest class API for more information., _(*10)

Structure

Resources are what you can get in the League of Legends API. Bellow there are different resources and how to use them, with examples., _(*11)

ResourceHandler

Every resource class extends from this. This is where the core is., _(*12)

Champion

Get info of a specific champion, _(*13)

Featured Games

Get info of the current game., _(*14)

Game

Get info of the current game., _(*15)

League

Get info of the current game., _(*16)