team-reflex / smite-api
Easy access to the Hi-Rez Studios API for Smite
Installs: 6 595
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 4
Forks: 0
Open Issues: 0
Requires
- php: >=5.4.0
- guzzlehttp/guzzle: ^6.1|^6.2
- onoi/cache: ^1.2
Requires (Dev)
README
A simple object-oriented approach to data in the Smite API (a game from Hi-Rez Studios).
For use within WordPress, consider using the official WP plugin from Hi-Rez.
For more information about the Smite API, refer to the official API documentation.
Requirements
- PHP 5.4 or greater
- DevID and AuthKey from Hi-Rez (submit this form)
Installation
$ composer require team-reflex/smite-api
Usage
// Create api $api = new Reflex\Smite\API(DEV_ID, AUTH_KEY); // optional session caching via many providers // see https://github.com/onoi/cache/ $api->useCache(new \Onoi\Cache\ZendCache($zendCacheThing)); $api->useCache(new \Onoi\Cache\DoctrineCache($doctrineCacheThing)); $api->useCache(new \Onoi\Cache\MediaWikiCache(wfGetCache(CACHE_ANYTHING))); // returns objects by default $api->preferredFormat('array'); // will now return assoc arrays // returns english language gods and item names by default $api->preferredLanguage('es'); // use IETF language tag to select language // (latin america becomes es-419) // get player info $playerData = $api->getplayer($playerName); // get info on silver 3 ladder in season 4 $ladderData = $api->getleagueleaderboard('Conquest5v5', 'Silver3', 4);
Laravel Cache
We have an Illuminate driver for onoi/cache found here: https://github.com/teamreflex/Onoi-Illuminate
Contributing
- Fork
git clone
composer install
- Hack
- Confirm (and write new) passing tests:
vendor/bin/phpunit
- Submit pull request
License
Copyright 2015 Curse, Inc.
Free for you to use under LGPLv3. See LICENSE for an abundance of words.