AuthProvider
in package
implements
AuthProviderInterface
AbstractYes
Auth provider base class.
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
- Authenticate 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
- init() : void
- Init provider
Properties
$params
Provider params
protected
array<string|int, mixed>
$params
$user
Current auth user
protected
array<string|int, mixed>|null
$user
$userProvider
User provider
protected
UserProviderInterface
$userProvider
Methods
__construct()
Constructor
public
__construct([array<string|int, mixed> $params = [] ]) : mixed
Parameters
- $params : array<string|int, mixed> = []
authenticate()
Authenticate user
public
abstract authenticate(array<string|int, mixed> $credentials[, ServerRequestInterface|null $request = null ]) : bool
Parameters
- $credentials : array<string|int, mixed>
- $request : ServerRequestInterface|null = null
Return values
boolgetId()
Get current auth id
public
getId() : int|null
Return values
int|nullgetLoginAttempts()
Get login attempts
public
getLoginAttempts() : int|null
Return values
int|nullgetParam()
Get param
public
getParam(string $name[, mixed $default = null ]) : mixed|null
Parameters
- $name : string
- $default : mixed = null
Return values
mixed|nullgetProvider()
Return user provider
public
getProvider() : UserProviderInterface
Return values
UserProviderInterfacegetUser()
Get current auth user
public
getUser() : array<string|int, mixed>|null
Return values
array<string|int, mixed>|nullisLogged()
Check if user is logged
public
isLogged() : bool
Return values
boollogout()
Logout
public
abstract logout() : void
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
setProvider()
Set user provider
public
setProvider(UserProviderInterface $userProvider) : void
Parameters
- $userProvider : UserProviderInterface
init()
Init provider
protected
init() : void