1. class
  2. Arikaim
  3. \
  4. Core
  5. \
  6. Access
  7. \
  8. Provider
  9. \
  10. AuthProvider

AuthProvider

abstract class AuthProvider implements AuthProviderInterface

Auth provider base class.

Properties

protected UserProviderInterface $userProvider User provider
protected array|null $user Current auth user
protected array $params Provider params

Methods

__construct(UserProviderInterface $userProvider, array $params = [])

Constructor

static string|null
readAuthHeader(ServerRequestInterface $request, bool $bearer = true)

Get token from request header

bool
isLogged()

Check if user is logged

void
init()

Init provider

mixed|null
getParam(string $name, mixed $default = null)

Get param

UserProviderInterface
getProvider()

Return user provider

array|null
getUser()

Get current auth user

integer|null
getId()

Get current auth id

void
setProvider(UserProviderInterface $userProvider)

Set user provider

int|null
getLoginAttempts()

Get login attempts

bool
authenticate(array $credentials, ServerRequestInterface|null $request = null)

Authenticate user

void
logout()

Logout

Details

at line 49
__construct(UserProviderInterface $userProvider, array $params = [])

Constructor

Parameters

UserProviderInterface $userProvider
array $params

at line 64
static string|null readAuthHeader(ServerRequestInterface $request, bool $bearer = true)

Get token from request header

Parameters

ServerRequestInterface $request
bool $bearer

Return Value

string|null Api token

at line 85
bool isLogged()

Check if user is logged

Return Value

bool

at line 95
protected void init()

Init provider

Return Value

void

at line 106
mixed|null getParam(string $name, mixed $default = null)

Get param

Parameters

string $name
mixed $default

Return Value

mixed|null

at line 116
UserProviderInterface getProvider()

Return user provider

Return Value

UserProviderInterface

at line 126
array|null getUser()

Get current auth user

Return Value

array|null

at line 136
integer|null getId()

Get current auth id

Return Value

integer|null

at line 146
void setProvider(UserProviderInterface $userProvider)

Set user provider

Parameters

UserProviderInterface $userProvider

Return Value

void

at line 156
int|null getLoginAttempts()

Get login attempts

Return Value

int|null

at line 168
abstract bool authenticate(array $credentials, ServerRequestInterface|null $request = null)

Authenticate user

Parameters

array $credentials
ServerRequestInterface|null $request

Return Value

bool

at line 175
abstract void logout()

Logout

Return Value

void