RequestAuthenticationService
in package
implements
WebRequestAuthenticationService, WebRequestUserIdentificationService
Class RequestAuthenticationService
Interfaces, Classes and Traits
- WebRequestAuthenticationService
- Interface WebRequestAuthenticationService
- WebRequestUserIdentificationService
- Interface WebRequestUserIdentifier
Table of Contents
- $authenticators : array<string|int, WebRequestAuthenticator>
- $permissionService : PermissionService
- $url : Url
- __construct() : mixed
- RequestAuthenticationService constructor.
- addAuthenticator() : $this
- Adds a web request authenticator to the service, which will be used to authenticate a web request.
- authenticateWebRequest() : bool
- Authenticates the provided server request.
- identifyUser() : int
- Identifies the user from the provided server request.
- checkAdminPermission() : bool
Properties
$authenticators
private
array<string|int, WebRequestAuthenticator>
$authenticators
$permissionService
private
PermissionService
$permissionService
$url
private
Url
$url
Methods
__construct()
RequestAuthenticationService constructor.
public
__construct(PermissionService $permissionService, Url $url, WebRequestAuthenticator ...$authenticators) : mixed
Parameters
- $permissionService : PermissionService
- $url : Url
- $authenticators : WebRequestAuthenticator
Return values
mixed —addAuthenticator()
Adds a web request authenticator to the service, which will be used to authenticate a web request.
public
addAuthenticator(WebRequestAuthenticator $authenticator) : $this
Parameters
- $authenticator : WebRequestAuthenticator
Tags
Return values
$this —authenticateWebRequest()
Authenticates the provided server request.
public
authenticateWebRequest(ServerRequestInterface $request) : bool
Parameters
- $request : ServerRequestInterface
Tags
Return values
bool —True, if authentication succeeded, otherwise false.
identifyUser()
Identifies the user from the provided server request.
public
identifyUser(ServerRequestInterface $request) : int
Parameters
- $request : ServerRequestInterface
Tags
Return values
int —Positive integer, if authentication succeeded, otherwise null.
checkAdminPermission()
private
checkAdminPermission(int $userId, ServerRequestInterface $request) : bool
Parameters
- $userId : int
- $request : ServerRequestInterface