PHP Class Invisnik\LaravelSteamAuth\SteamAuth

Inheritance: implements Invisnik\LaravelSteamAuth\SteamAuthInterface
Show file Open project: invisnik/laravel-steam-auth Class Usage Examples

Public Properties

Property Type Description
$authUrl string
$steamId integer | null
$steamInfo SteamInfo

Public Methods

Method Description
__construct ( Illuminate\Http\Request $request ) : void Create a new SteamAuth instance
getAuthUrl ( ) : string Returns the login url
getParams ( ) : array Get param list for openId validation
getSteamId ( ) : boolean | string Returns the steam id
getUserInfo ( ) : SteamInfo Returns the SteamUser info
parseInfo ( ) : void Get user data from steam api
parseResults ( string $results ) : Illuminate\Support\Fluent Parse openID reponse to fluent object
parseSteamID ( ) : void Parse the steamID from the OpenID response
redirect ( ) : Illuminate\Http\RedirectResponse | Redirector Returns the redirect response to login
validate ( ) : boolean Checks the steam login

Private Methods

Method Description
buildUrl ( string $return = null ) : string Build the Steam login URL
requestIsValid ( ) : boolean Validates if the request object has required stream attributes.
validateUrl ( string $url ) : boolean Validates a given URL, ensuring it contains the http or https URI Scheme

Method Details

__construct() public method

Create a new SteamAuth instance
public __construct ( Illuminate\Http\Request $request ) : void
$request Illuminate\Http\Request
return void

getAuthUrl() public method

Returns the login url
public getAuthUrl ( ) : string
return string

getParams() public method

Get param list for openId validation
public getParams ( ) : array
return array

getSteamId() public method

Returns the steam id
public getSteamId ( ) : boolean | string
return boolean | string

getUserInfo() public method

Returns the SteamUser info
public getUserInfo ( ) : SteamInfo
return SteamInfo

parseInfo() public method

Get user data from steam api
public parseInfo ( ) : void
return void

parseResults() public method

Parse openID reponse to fluent object
public parseResults ( string $results ) : Illuminate\Support\Fluent
$results string openid reponse body
return Illuminate\Support\Fluent

parseSteamID() public method

Parse the steamID from the OpenID response
public parseSteamID ( ) : void
return void

redirect() public method

Returns the redirect response to login
public redirect ( ) : Illuminate\Http\RedirectResponse | Redirector
return Illuminate\Http\RedirectResponse | Illuminate\Routing\Redirector

validate() public method

Checks the steam login
public validate ( ) : boolean
return boolean

Property Details

$authUrl public property

public string $authUrl
return string

$steamId public property

public int|null $steamId
return integer | null

$steamInfo public property

public SteamInfo,Invisnik\LaravelSteamAuth $steamInfo
return SteamInfo