PHP Class LeagueWrap\Api\League

Inheritance: extends AbstractApi

Show file 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 league api call.
$versions	array	Valid version for this api call.

Public Methods

Method	Description
challenger ( string $type = 'RANKED_SOLO_5x5' ) : array	Gets the league information for the challenger teams.
getDomain ( ) : String
league ( Summoner \| Int $identities, boolean $entry = false ) : array	Gets the league information by summoner id or list of summoner ids. To only get the single entry information for the summoner(s) ensure that $entry is set to true.

Method Details

challenger() public method

Gets the league information for the challenger teams.

public challenger ( string $type = 'RANKED_SOLO_5x5' ) : array
$type	string
return	array

getDomain() public method

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

league() public method

Gets the league information by summoner id or list of summoner ids. To only get the single entry information for the summoner(s) ensure that $entry is set to true.

public league ( Summoner \| Int $identities, boolean $entry = false ) : array
$identities	Summoner \| Int
$entry	boolean
return	array

Property Details

$defaultRemember protected property

The amount of time we intend to remember the response for.

protected int $defaultRemember
return	integer

$permittedRegions protected property

A list of all permitted regions for the league api call.

protected $permittedRegions

$versions protected property

Valid version for this api call.

protected array $versions
return	array