PHP Class LeagueWrap\Api\Summoner

Inheritance: extends AbstractApi
Datei anzeigen Open project: paquettg/leaguewrap

Protected Properties

Property Type Description
$defaultRemember integer The amount of time we intend to remember the response for.
$permittedRegions A list of all permitted regions for the Champion api call.
$summoners array The summoners we have loaded.
$versions array Valid version for this api call.

Public Methods

Method Description
__get ( string $key ) : object | null Attempt to get a summoner by key.
allInfo ( mixed $identities ) : LeagueWrap\Dto\Summoner; Attempts to get all information about this user. This method will make 3 requests!
get ( string $key ) : object | null Attempt to get a summoner by key.
getDomain ( ) : String
info ( mixed $identities ) : LeagueWrap\Dto\Summoner Gets the information about the user by the given identification. IDs must be of type integer, otherwise, numeric string values will be assumed to be names.
masteryPages ( mixed $identities ) : array Gets all the mastery pages of the given user object or id.
name ( mixed $identities ) : array Gets the name of each summoner from a list of ids.
runePages ( mixed $identities ) : array Gets all rune pages of the given user object or id.

Protected Methods

Method Description
infoByIds ( array $ids ) : LeagueWrap\Dto\Summoner | LeagueWrap\Dto\Summoner[]; Gets the information by the id of the summoner.
infoByNames ( array $names ) : LeagueWrap\Dto\Summoner | LeagueWrap\Dto\Summoner[]; Gets the information by the name of the summoner.

Method Details

__get() public method

Attempt to get a summoner by key.
public __get ( string $key ) : object | null
$key string
return object | null

allInfo() public method

Attempts to get all information about this user. This method will make 3 requests!
public allInfo ( mixed $identities ) : LeagueWrap\Dto\Summoner;
$identities mixed
return LeagueWrap\Dto\Summoner;

get() public method

Attempt to get a summoner by key.
public get ( string $key ) : object | null
$key string
return object | null

getDomain() public method

public getDomain ( ) : String
return String domain used for the request

info() public method

Gets the information about the user by the given identification. IDs must be of type integer, otherwise, numeric string values will be assumed to be names.
public info ( mixed $identities ) : LeagueWrap\Dto\Summoner
$identities mixed
return LeagueWrap\Dto\Summoner

infoByIds() protected method

Gets the information by the id of the summoner.
protected infoByIds ( array $ids ) : LeagueWrap\Dto\Summoner | LeagueWrap\Dto\Summoner[];
$ids array
return LeagueWrap\Dto\Summoner | LeagueWrap\Dto\Summoner[];

infoByNames() protected method

Gets the information by the name of the summoner.
protected infoByNames ( array $names ) : LeagueWrap\Dto\Summoner | LeagueWrap\Dto\Summoner[];
$names array
return LeagueWrap\Dto\Summoner | LeagueWrap\Dto\Summoner[];

masteryPages() public method

Gets all the mastery pages of the given user object or id.
public masteryPages ( mixed $identities ) : array
$identities mixed
return array

name() public method

Gets the name of each summoner from a list of ids.
public name ( mixed $identities ) : array
$identities mixed
return array

runePages() public method

Gets all rune pages of the given user object or id.
public runePages ( mixed $identities ) : array
$identities mixed
return array

Property Details

$defaultRemember protected_oe property

The amount of time we intend to remember the response for.
protected int $defaultRemember
return integer

$permittedRegions protected_oe property

A list of all permitted regions for the Champion api call.
protected $permittedRegions

$summoners protected_oe property

The summoners we have loaded.
protected array $summoners
return array

$versions protected_oe property

Valid version for this api call.
protected array $versions
return array