PHP Class LeagueWrap\Region

Show file Open project: paquettg/leaguewrap Class Usage Examples

Protected Properties

Property Type Description
$championMasteryDomain
$currentGameDomain
$defaultDomain The default domain to attempt to query
$defaultStaticDomain The default domain for static queries
$featuredGameDomain
$platformIds
$region The region that this object represents.
$statusDomain

Public Methods

Method Description
__construct ( $region )
getChampionMasteryDomain ( )
getCurrentGameDomain ( )
getDefaultDomain ( ) : string Returns the domain that this region needs to make its request.
getFeaturedGamesDomain ( ) : string Returns the observer domain that this region needs to make its request.
getRegion ( ) : string Returns the region that was passed in the constructor.
getStaticDataDomain ( ) : string Returns the static data domain that this region needs to make its request.
getStatusDomain ( )
isLocked ( array $regions ) : boolean Determines wether the given region is locked out.

Protected Methods

Method Description
getPlatformId ( ) : String

Method Details

__construct() public method

public __construct ( $region )
$region

getChampionMasteryDomain() public method

public getChampionMasteryDomain ( )

getCurrentGameDomain() public method

public getCurrentGameDomain ( )

getDefaultDomain() public method

Returns the domain that this region needs to make its request.
public getDefaultDomain ( ) : string
return string

getFeaturedGamesDomain() public method

Returns the observer domain that this region needs to make its request.
public getFeaturedGamesDomain ( ) : string
return string

getPlatformId() protected method

protected getPlatformId ( ) : String
return String platform id for the selected version

getRegion() public method

Returns the region that was passed in the constructor.
public getRegion ( ) : string
return string

getStaticDataDomain() public method

Returns the static data domain that this region needs to make its request.
public getStaticDataDomain ( ) : string
return string

getStatusDomain() public method

public getStatusDomain ( )

isLocked() public method

Determines wether the given region is locked out.
public isLocked ( array $regions ) : boolean
$regions array
return boolean

Property Details

$championMasteryDomain protected property

protected $championMasteryDomain

$currentGameDomain protected property

protected $currentGameDomain

$defaultDomain protected property

The default domain to attempt to query
protected $defaultDomain

$defaultStaticDomain protected property

The default domain for static queries
protected $defaultStaticDomain

$featuredGameDomain protected property

protected $featuredGameDomain

$platformIds protected property

protected $platformIds

$region protected property

The region that this object represents.
protected $region

$statusDomain protected property

protected $statusDomain