Skip to content
🌁 A full-on Framework for working with the Riot API. Featuring DTO's, Caching & Automatic Rate limiting for PHP 7
Branch: master
Clone or download
Latest commit f39900e Apr 23, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github Create PULL_REQUEST_TEMPLATE.md Apr 4, 2019
bin Patches another console error Apr 22, 2019
src Fix alongside 1.0.3 Apr 23, 2019
tests Fixes test with new API Apr 22, 2019
.env.example Documentation updates Apr 2, 2019
CODE_OF_CONDUCT.md Added Code of conduct Apr 4, 2019
CONTRIBUTING.md Add contributing guidelines Apr 4, 2019
LICENSE Static data serving Mar 29, 2019
README.md
composer.json Composer fix Apr 22, 2019
phpunit.xml Need to fix major bug Mar 24, 2019

README.md

RiotQuest

RiotQuest is a modern PHP 7+ framework for the League of Legends API

The framework aims at giving you a simple way to interact with the API.

Here's a list of some of RiotQuest's features.

  • Automatic Rate Limiting: The rate limiter component prevents you from passing the rate limits - no blacklists or 429's! And of course it's automatic!
  • Automatic Caching: The framework caches every successful request - automatically!
  • Custom Collections: Every request returns an object which makes data management significantly easier!
  • Environment: Load API keys using the environment!
  • Command Line Interface: Use the API within the command line as well as managing caches!
  • Standardized with PSR-1, PSR-2, PSR-4 & PSR-16

The entire project is licensed under the MIT License.

Getting Started

Prerequisites

The library uses Composer for class autoloading and dependency management. Here is a list of things you'll need to get started with RiotQuest.

  • PHP 7.0+
  • ext-json
  • ext-curl
  • Composer

Installation

To install RiotQuest, simply install it using Composer.

$ composer require supergrecko/riot-quest

Usage

To get you started, we've created a 3-step guide to working with the framework.

This guide should get you up and working.

Example

Make a request to Summoner V4 on NA with Summoner Name "RiotSchmick"

<?php

require __DIR__ . '/vendor/autoload.php';

use RiotQuest\Client;
Client::boot();

$summoner = Client::summoner('na1')->name('RiotSchmick');
?>

Endpoints

RiotQuest currently supports every endpoint except Tournament related ones.

You can’t perform that action at this time.