PHP Класс Invisnik\LaravelSteamAuth\SteamAuth

Наследование: implements Invisnik\LaravelSteamAuth\SteamAuthInterface
Показать файл Открыть проект Примеры использования класса

Открытые свойства

Свойство Тип Описание
$authUrl string
$steamId integer | null
$steamInfo SteamInfo

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

Метод Описание
__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

Приватные методы

Метод Описание
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

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

__construct() публичный метод

Create a new SteamAuth instance
public __construct ( Illuminate\Http\Request $request ) : void
$request Illuminate\Http\Request
Результат void

getAuthUrl() публичный метод

Returns the login url
public getAuthUrl ( ) : string
Результат string

getParams() публичный метод

Get param list for openId validation
public getParams ( ) : array
Результат array

getSteamId() публичный метод

Returns the steam id
public getSteamId ( ) : boolean | string
Результат boolean | string

getUserInfo() публичный метод

Returns the SteamUser info
public getUserInfo ( ) : SteamInfo
Результат SteamInfo

parseInfo() публичный метод

Get user data from steam api
public parseInfo ( ) : void
Результат void

parseResults() публичный метод

Parse openID reponse to fluent object
public parseResults ( string $results ) : Illuminate\Support\Fluent
$results string openid reponse body
Результат Illuminate\Support\Fluent

parseSteamID() публичный метод

Parse the steamID from the OpenID response
public parseSteamID ( ) : void
Результат void

redirect() публичный метод

Returns the redirect response to login
public redirect ( ) : Illuminate\Http\RedirectResponse | Redirector
Результат Illuminate\Http\RedirectResponse | Illuminate\Routing\Redirector

validate() публичный метод

Checks the steam login
public validate ( ) : boolean
Результат boolean

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

$authUrl публичное свойство

public string $authUrl
Результат string

$steamId публичное свойство

public int|null $steamId
Результат integer | null

$steamInfo публичное свойство

public SteamInfo,Invisnik\LaravelSteamAuth $steamInfo
Результат SteamInfo