Arikaim CMS

OauthProvider extends SessionAuthProvider
in package
implements AuthProviderInterface

OAuth provider.

Table of Contents

Interfaces

AuthProviderInterface
Auth provider interface

Properties

$params  : array<string|int, mixed>
Provider params
$user  : array<string|int, mixed>|null
Current auth user
$userProvider  : UserProviderInterface
User provider

Methods

__construct()  : mixed
Constructor
authenticate()  : bool
Auth user
getId()  : int|null
Get current auth id
getLoginAttempts()  : int|null
Get login attempts
getParam()  : mixed|null
Get param
getProvider()  : UserProviderInterface
Return user provider
getUser()  : array<string|int, mixed>|null
Get current auth user
isLogged()  : bool
Check if user is logged
logout()  : void
Logout
readAuthHeader()  : string|null
Get token from request header
setProvider()  : void
Set user provider
fail()  : void
Fail auth
init()  : void
Init provider
success()  : void
Scucess auth

Properties

$params

Provider params

protected array<string|int, mixed> $params

$user

Current auth user

protected array<string|int, mixed>|null $user

Methods

__construct()

Constructor

public __construct([array<string|int, mixed> $params = [] ]) : mixed
Parameters
$params : array<string|int, mixed> = []

authenticate()

Auth user

public authenticate(array<string|int, mixed> $credentials[, ServerRequestInterface|null $request = null ]) : bool
Parameters
$credentials : array<string|int, mixed>
$request : ServerRequestInterface|null = null
Return values
bool

getId()

Get current auth id

public getId() : int|null
Return values
int|null

getLoginAttempts()

Get login attempts

public getLoginAttempts() : int|null
Return values
int|null

getParam()

Get param

public getParam(string $name[, mixed $default = null ]) : mixed|null
Parameters
$name : string
$default : mixed = null
Return values
mixed|null

getUser()

Get current auth user

public getUser() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|null

isLogged()

Check if user is logged

public isLogged() : bool
Return values
bool

readAuthHeader()

Get token from request header

public static readAuthHeader(RequestInterface $request[, bool $bearer = true ]) : string|null
Parameters
$request : RequestInterface
$bearer : bool = true
Return values
string|null —

Api token


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results