PHP Класс LeagueWrap\Api\Staticdata

Наследование: extends AbstractApi
Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$DDversion string The version of League of Legends that we want data from. By default it is not passed (null).
$dataById array A list of all calls that require to get the data by Id
$defaultRemember integer The amount of time we intend to remember the response for.
$locale string The locale you want the response in. By default it is not passed (null).
$permittedRegions array A list of all permitted regions for the Staticdata api call.
$versions array Valid version for this api call.

Открытые методы

Метод Описание
getChampion ( integer $championId, mixed $data = null ) : LeagueWrap\Dto\StaticData\ChampionList | Champion Gets the static champion data of all champions if $championId is null.
getChampions ( mixed $data = null ) : LeagueWrap\Dto\StaticData\ChampionList Gets all static champion data with the given $data option.
getDomain ( ) : String
getItem ( integer $itemId, mixed $data = null ) : LeagueWrap\Dto\StaticData\Item | LeagueWrap\Dto\StaticData\ItemList Gets the static item data of all items if $itemId is null.
getItems ( mixed $data = null ) : LeagueWrap\Dto\StaticData\ItemList Gets static data on all items.
getMasteries ( mixed $data = null ) : LeagueWrap\Dto\StaticData\MasteryList Gets static data on all masteries.
getMastery ( integer $masteryId, mixed $data = null ) : LeagueWrap\Dto\StaticData\MasteryList | LeagueWrap\Dto\StaticData\Mastery Gets the mastery data of all masteries if $masteryId is null.
getRealm ( ) : LeagueWrap\Dto\StaticData\Realm Get the realm information for the current region.
getRune ( integer $runeId, mixed $data = null ) : LeagueWrap\Dto\StaticData\RuneList | LeagueWrap\Dto\StaticData\Rune Gets the rune data of all runes if $runeId is null.
getRunes ( mixed $data = null ) : LeagueWrap\Dto\StaticData\RuneList Gets static data on all runes.
getSummonerSpell ( integer $summonerSpellId, mixed $data = null ) : LeagueWrap\Dto\StaticData\SummonerSpell | LeagueWrap\Dto\StaticData\SummonerSpellList Gets the summoner spell data of all spells if $summonerSpellId is null If $summonerSpellId is set it will attept to get info for that spell only.
getSummonerSpells ( mixed $data = null ) : LeagueWrap\Dto\StaticData\SummonerSpellList Gets static data on all summoner spells.
setDDversion ( string $DDversion = null ) Sets the DDversion to be used in the query. Null will return the most recent version.
setLocale ( string $locale ) Sets the locale the data should be returned in. Null returns the default local for that region.
version ( ) : Array Get the version information for the current region.

Защищенные методы

Метод Описание
appendId ( mixed $requestId ) : boolean Check if we should append the id to the end of the url or not.
dataById ( $name ) : boolean Check if we need the data by Id
makeRequest ( string $path, mixed $requestId, array $params ) : array Make the request given the proper information.
setUpParams ( string $name = '', mixed $requestId = null, mixed $data = null, string $listData = '', string $itemData = '' ) : array Set up the boiler plate for the param array for any static data call.

Описание методов

appendId() защищенный Метод

Check if we should append the id to the end of the url or not.
protected appendId ( mixed $requestId ) : boolean
$requestId mixed
Результат boolean

dataById() защищенный Метод

Check if we need the data by Id
protected dataById ( $name ) : boolean
$name string
Результат boolean

getChampion() публичный Метод

If $championI is set it will attempt to get info for that champion only.
public getChampion ( integer $championId, mixed $data = null ) : LeagueWrap\Dto\StaticData\ChampionList | Champion
$championId integer
$data mixed
Результат LeagueWrap\Dto\StaticData\ChampionList | Champion

getChampions() публичный Метод

Gets all static champion data with the given $data option.
public getChampions ( mixed $data = null ) : LeagueWrap\Dto\StaticData\ChampionList
$data mixed
Результат LeagueWrap\Dto\StaticData\ChampionList

getDomain() публичный Метод

public getDomain ( ) : String
Результат String domain used for the request

getItem() публичный Метод

If $itemId is set it will attempt to get info for that item only.
public getItem ( integer $itemId, mixed $data = null ) : LeagueWrap\Dto\StaticData\Item | LeagueWrap\Dto\StaticData\ItemList
$itemId integer
$data mixed
Результат LeagueWrap\Dto\StaticData\Item | LeagueWrap\Dto\StaticData\ItemList

getItems() публичный Метод

Gets static data on all items.
public getItems ( mixed $data = null ) : LeagueWrap\Dto\StaticData\ItemList
$data mixed
Результат LeagueWrap\Dto\StaticData\ItemList

getMasteries() публичный Метод

Gets static data on all masteries.
public getMasteries ( mixed $data = null ) : LeagueWrap\Dto\StaticData\MasteryList
$data mixed
Результат LeagueWrap\Dto\StaticData\MasteryList

getMastery() публичный Метод

If $masteryId is a set it will attempt to get info for that mastery only.
public getMastery ( integer $masteryId, mixed $data = null ) : LeagueWrap\Dto\StaticData\MasteryList | LeagueWrap\Dto\StaticData\Mastery
$masteryId integer
$data mixed
Результат LeagueWrap\Dto\StaticData\MasteryList | LeagueWrap\Dto\StaticData\Mastery

getRealm() публичный Метод

Get the realm information for the current region.
public getRealm ( ) : LeagueWrap\Dto\StaticData\Realm
Результат LeagueWrap\Dto\StaticData\Realm

getRune() публичный Метод

If $runeId is set it will attempt to get info for that rune only.
public getRune ( integer $runeId, mixed $data = null ) : LeagueWrap\Dto\StaticData\RuneList | LeagueWrap\Dto\StaticData\Rune
$runeId integer
$data mixed
Результат LeagueWrap\Dto\StaticData\RuneList | LeagueWrap\Dto\StaticData\Rune

getRunes() публичный Метод

Gets static data on all runes.
public getRunes ( mixed $data = null ) : LeagueWrap\Dto\StaticData\RuneList
$data mixed
Результат LeagueWrap\Dto\StaticData\RuneList

getSummonerSpell() публичный Метод

Gets the summoner spell data of all spells if $summonerSpellId is null If $summonerSpellId is set it will attept to get info for that spell only.
public getSummonerSpell ( integer $summonerSpellId, mixed $data = null ) : LeagueWrap\Dto\StaticData\SummonerSpell | LeagueWrap\Dto\StaticData\SummonerSpellList
$summonerSpellId integer
$data mixed
Результат LeagueWrap\Dto\StaticData\SummonerSpell | LeagueWrap\Dto\StaticData\SummonerSpellList

getSummonerSpells() публичный Метод

Gets static data on all summoner spells.
public getSummonerSpells ( mixed $data = null ) : LeagueWrap\Dto\StaticData\SummonerSpellList
$data mixed
Результат LeagueWrap\Dto\StaticData\SummonerSpellList

makeRequest() защищенный Метод

Make the request given the proper information.
protected makeRequest ( string $path, mixed $requestId, array $params ) : array
$path string
$requestId mixed
$params array
Результат array

setDDversion() публичный Метод

Sets the DDversion to be used in the query. Null will return the most recent version.
public setDDversion ( string $DDversion = null )
$DDversion string

setLocale() публичный Метод

Sets the locale the data should be returned in. Null returns the default local for that region.
public setLocale ( string $locale )
$locale string

setUpParams() защищенный Метод

Set up the boiler plate for the param array for any static data call.
protected setUpParams ( string $name = '', mixed $requestId = null, mixed $data = null, string $listData = '', string $itemData = '' ) : array
$name string of api call
$requestId mixed
$data mixed
$listData string
$itemData string
Результат array

version() публичный Метод

Get the version information for the current region.
public version ( ) : Array
Результат Array

Описание свойств

$DDversion защищенное свойство

The version of League of Legends that we want data from. By default it is not passed (null).
protected string $DDversion
Результат string

$dataById защищенное свойство

A list of all calls that require to get the data by Id
protected array $dataById
Результат array

$defaultRemember защищенное свойство

The amount of time we intend to remember the response for.
protected int $defaultRemember
Результат integer

$locale защищенное свойство

The locale you want the response in. By default it is not passed (null).
protected string $locale
Результат string

$permittedRegions защищенное свойство

A list of all permitted regions for the Staticdata api call.
protected array $permittedRegions
Результат array

$versions защищенное свойство

Valid version for this api call.
protected array $versions
Результат array