SecurityService
in package
Table of Contents
Properties
- $activeUser : AbstractUser|null
- $authenticatedUser : AbstractUser|null
- $authentication : AbstractAuthentication|null
- $authenticationManager : AuthenticationManager
- $authenticationManagerClass : string
- $instance : SecurityService
Methods
- authenticate() : void
- consumeNavigationKey() : mixed
- get() : SecurityService
- getActiveUser() : AbstractUser|null
- getAuthenticatedUser() : AbstractUser|null
- getAuthentication() : AbstractAuthentication|null
- getAuthenticationExpirationTargetRoute() : string|null
- getAuthenticationForbiddenTargetRoute() : string|null
- getAuthenticationLoginRecoverMethod() : string
- getAuthenticationManager() : AuthenticationManager
- getForbiddenHttpResponse() : HttpResponse|null
- invalidateAuthentication() : void
- isAuthenticated() : bool
- isAuthenticationLoginRecoveringNavigation() : bool
- loadUserAuthentication() : void
- setActiveUser() : void
- setPersistentAuthentication() : void
- generateNavigationKey() : string
Properties
$activeUser
private
AbstractUser|null
$activeUser
= null
$authenticatedUser
private
AbstractUser|null
$authenticatedUser
= null
$authentication
private
AbstractAuthentication|null
$authentication
= null
$authenticationManager
private
AuthenticationManager
$authenticationManager
$authenticationManagerClass
private
string
$authenticationManagerClass
= \Orpheus\Authentication\OrpheusAuthenticationManager::class
$instance
private
static SecurityService
$instance
Methods
authenticate()
public
authenticate(AbstractAuthentication $authentication) : void
Parameters
- $authentication : AbstractAuthentication
consumeNavigationKey()
public
consumeNavigationKey(string $key) : mixed
Parameters
- $key : string
get()
public
static get() : SecurityService
Return values
SecurityServicegetActiveUser()
public
getActiveUser() : AbstractUser|null
Return values
AbstractUser|nullgetAuthenticatedUser()
public
getAuthenticatedUser() : AbstractUser|null
Return values
AbstractUser|nullgetAuthentication()
public
getAuthentication() : AbstractAuthentication|null
Return values
AbstractAuthentication|nullgetAuthenticationExpirationTargetRoute()
public
getAuthenticationExpirationTargetRoute() : string|null
Return values
string|nullgetAuthenticationForbiddenTargetRoute()
public
getAuthenticationForbiddenTargetRoute() : string|null
Return values
string|nullgetAuthenticationLoginRecoverMethod()
public
getAuthenticationLoginRecoverMethod() : string
Return values
stringgetAuthenticationManager()
public
getAuthenticationManager() : AuthenticationManager
Return values
AuthenticationManagergetForbiddenHttpResponse()
public
getForbiddenHttpResponse(ForbiddenException $exception) : HttpResponse|null
Parameters
- $exception : ForbiddenException
Return values
HttpResponse|nullinvalidateAuthentication()
public
invalidateAuthentication() : void
isAuthenticated()
public
isAuthenticated() : bool
Return values
boolisAuthenticationLoginRecoveringNavigation()
public
isAuthenticationLoginRecoveringNavigation() : bool
Return values
boolloadUserAuthentication()
public
loadUserAuthentication(InputRequest $request) : void
Parameters
- $request : InputRequest
setActiveUser()
public
setActiveUser(AbstractUser $user) : void
Parameters
- $user : AbstractUser
setPersistentAuthentication()
public
setPersistentAuthentication(AbstractUser $user) : void
Parameters
- $user : AbstractUser
generateNavigationKey()
protected
generateNavigationKey(HttpRequest|null $request) : string
Parameters
- $request : HttpRequest|null