dolejska-daniel/challonge-api

ChallongeAPI wrapper for PHP7

v0.3 2017-06-29 07:18 UTC

README

Version pre-v0.4

Build Status Test Coverage GitHub release GitHub pre release Packagist Packagist

Table of Contents

  1. Introduction
  2. ChallongeAPI
    1. Initializing the library
    2. Using the library
    3. Taking advantage of objects

Introduction

This is Challonge API wrapper for PHP7!

With easy usage and clean code.

ChallongeAPI

Initializing the library

Initializing the library is easy, it just needs array of settings. Mainly, your SET_API_KEY. Take a look:

use ChallongeAPI\ChallongeAPI;

$api = new ChallongeAPI([
	//  Your Challonge API key, you can get one at https://challonge.com/settings/developer
	ChallongeAPI::SET_API_KEY => 'YOUR_CHALLONGE_API_KEY'
]);

Available library settings:

Name Value Description
SET_API_KEY string Required. Your Challonge API key, you can get one at https://challonge.com/settings/developer
SET_VERIFY_SSL bool Useful when debuging on localhost, cURL might throw SSL verification errors. Should not be used in production.

Using the library

Working with Challonge API was never easier!

// Fetches all tournaments created on your account
$api->tList();

// Fetches all tournaments created by organization 'csgo' (csgo.challonge.com)
$api->tList('csgo');

Taking advantage of objects

// Fetches all tournaments created on your account
$list = $api->tList();

//  Outputs name of all tournaments on your account
foreach ($list->getTournaments() as $tournament)
	echo $tournament->name . "<br>";

//  Finds tournament by it's ID in the list
$tournament = $list->getTournamentById(123456789);
echo $tournament->name . "<br>";

//  Finds tournament by it's URL name in the list
$tournament = $list->getTournamentByUrl('best_tournament');
echo $tournament->name . "<br>";