D3 Documentation. Release 1. Khalifah K. Shabazz

Transcription

1 D3 Documentation Release 1 Khalifah K. Shabazz January 12, 2015

2

3 Contents 1 Description Kshabazz\BattleNet\D3\Connections Kshabazz\BattleNet\D3\Skills Indices and tables i

4 ii

5 CHAPTER 1 Description A PHP library for accessing the Battle.net Diablo 3 REST service. Contents: 1.1 Kshabazz\BattleNet\D3\Connections Kshabazz\BattleNet\D3\Connections\Connection class Connection Interface Resource gethero($pheroid) Request Hero JSON from Battle.Net. ex: <battlenetidnumber>/hero/<hero-id> Note: Leave off the trailing / when setting $pheroid null getitem($pitemid) Get item JSON from Battle.Net D3 API. ex: $pitemid null getitemsasmodels($pitemhashes) For each item the hero in the array construct an ModelItem and return them as an array. $pitemhashes (array) List of item hashes. Returns array null getprofile() ex: null 1

6 D3 Documentation, Release Kshabazz\BattleNet\D3\Connections\Http class Http Class Http constant API_PROFILE_URL constant API_HERO_URL constant API_ITEM_URL constant AUTHORIZE_URI constant TOKEN_URI construct($papikey, $pbattlenetid, $pclient, $plocale = en_us ) Constructor destruct() Destructor $papikey (string) Key obtained for use with Diablo 3 REST service. $pbattlenetid (string) BattleNet ID. $pclient (KshabazzSlibHttpClient) Client for making HTTP request. $plocale (string) battleneturlsafeid() Get BattleNet ID with the pound symbol replaced with a dash. BattleNet ID battlenetid() Get BattleNet ID BattleNet ID gethero($pheroid) Request Hero JSON from Battle.Net. <code> <?php // Make a request to: // <battlenetidnumber>/hero/<hero-id>?locale=<string>&apikey=<> // Note: Leave off the trailing / when setting?> </code> $pheroid (int) Hero ID. Returns null string getitem($pitemid) Make a request to the API to get an item (JSON). <code> // Make a request to: // </code> $pitemid (string) Can be obtained from items a hero has equipped. null API JSON data. 2 Chapter 1. Description

7 D3 Documentation, Release 1 getitemsasmodels($pitemhashes) For each item the hero has equipped construct an ModelItem and return them as an array. This is costly, it makes an HTTP request for each item in the list. $pitemhashes (array) List of item hash IDs. Returns array null Item models getprofile() Get a profile from Battle.net. <code> // Makes a request to: </code> Returns null string setregion($pregion) Set the region. url() $pregion makerequest($purl) Make a request to the currently set {@see $this->url}. $purl (string) null Kshabazz\BattleNet\D3\Connections\Sql class Sql Class Sql construct($pbattlenetid, PDO $ppdo, $pipaddress = NULL) Constructor $pbattlenetid (string) $ppdo (PDO) $pipaddress (string) addrequest($purl) Add a record of the Battle.net Web API request. $purl (string) The Battle.net url web API URL requested. Returns bool mixed 1.1. Kshabazz\BattleNet\D3\Connections 3

8 D3 Documentation, Release 1 gethero($pheroid) Get hero data from local database. $pheroid (int) null getitem($pitemhash) Get item JSON data from local database. $pitemhash (string) null getitemsasmodels($pitemhashes) $pitemhashes getprofile() Get the profile from local database. null savehero($pheroid, $pjson) Save the hero in a local database. $pheroid $pjson Returns bool Indicates success (TRUE) or failure (FALSE). saveitem(item $pitem, $shastring) Save the item locally in a database. $pitem (Item) $shastring (string) A unique string to use as a SHA seed for the item SHA value in the database. Returns bool saveprofile($pjson) Save the users profile locally to the database. $pjson (string) Returns bool 4 Chapter 1. Description

9 D3 Documentation, Release Kshabazz\BattleNet\D3\Skills Kshabazz\BattleNet\D3\Skills\Active class Active Class Skill construct($pskill) description() name() $pskill requiredlevel() simpledescription() slug() tooltipparams() Kshabazz\BattleNet\D3\Skills\Passive class Passive Class Skill construct($pproperies) description() flavor() name() $pproperies orderindex() Returns int requiredlevel() Returns int simpledescription() slug() tooltipparams() 1.2. Kshabazz\BattleNet\D3\Skills 5

10 D3 Documentation, Release 1 getproperty($property, $pproperties) Get the property or return null. $property $pproperties Returns null Kshabazz\BattleNet\D3\Skills\Skill class Skill Interface Skill construct($pskill) Constructor description() name() $pskill (array) requiredlevel() Returns int simpledescription() slug() tooltipparams() 1.3 Indices and tables genindex modindex search 6 Chapter 1. Description

11 Index Symbols construct() (Active method), 5 construct() (Http method), 2 construct() (Passive method), 5 construct() (Skill method), 6 construct() (Sql method), 3 destruct() (Http method), 2 A Active (class), 5 addrequest() (Sql method), 3 B battlenetid() (Http method), 2 battleneturlsafeid() (Http method), 2 C Connection (class), 1 D description() (Active method), 5 description() (Passive method), 5 description() (Skill method), 6 F flavor() (Passive method), 5 G gethero() (Connection method), 1 gethero() (Http method), 2 gethero() (Sql method), 3 getitem() (Connection method), 1 getitem() (Http method), 2 getitem() (Sql method), 4 getitemsasmodels() (Connection method), 1 getitemsasmodels() (Http method), 2 getitemsasmodels() (Sql method), 4 getprofile() (Connection method), 1 getprofile() (Http method), 3 getprofile() (Sql method), 4 getproperty() (Passive method), 6 H Http (class), 2 (class constant), 2 (class constant), 2 (class constant), 2 (class constant), 2 (class constant), 2 M makerequest() (Http method), 3 N name() (Active method), 5 name() (Passive method), 5 name() (Skill method), 6 O orderindex() (Passive method), 5 P Passive (class), 5 R requiredlevel() (Active method), 5 requiredlevel() (Passive method), 5 requiredlevel() (Skill method), 6 S savehero() (Sql method), 4 saveitem() (Sql method), 4 saveprofile() (Sql method), 4 setregion() (Http method), 3 simpledescription() (Active method), 5 simpledescription() (Passive method), 5 simpledescription() (Skill method), 6 Skill (class), 6 slug() (Active method), 5 slug() (Passive method), 5 7

12 D3 Documentation, Release 1 slug() (Skill method), 6 Sql (class), 3 T tooltipparams() (Active method), 5 tooltipparams() (Passive method), 5 tooltipparams() (Skill method), 6 U url() (Http method), 3 8 Index