SelfServiceHttpAuthLoginHandler
in package
implements
SelfServiceLoginHandler
Performs login with HTTP authentication.
Interfaces, Classes, Traits and Enums
- SelfServiceLoginHandler
- Login handler for self service
Table of Contents
- ID = "http_auth"
- $profile : selfServiceProfile
- __construct() : mixed
- Constructor
- addLoginFields() : void
- Adds necessary fields to the login dialog (e.g. user + password).
- authorize2FaUser() : void
- Authorizes an user that was provided by 2FA provider.
- getId() : string
- Returns a unique ID for the handler.
- getLoginName() : string
- Returns the login name.
- getLoginPassword() : string
- Returns the login password.
- isAuthenticationSuccessful() : bool
- Returns if the authentication was successful.
- managesAuthentication() : bool
- Returns if the login handler manages authentication on its own.
Constants
ID
public
mixed
ID
= "http_auth"
Properties
$profile
private
selfServiceProfile
$profile
Methods
__construct()
Constructor
public
__construct(selfServiceProfile $profile) : mixed
Parameters
- $profile : selfServiceProfile
-
profile
Return values
mixed —addLoginFields()
Adds necessary fields to the login dialog (e.g. user + password).
public
addLoginFields(htmlResponsiveRow $content) : void
Parameters
- $content : htmlResponsiveRow
-
dialog content
Tags
Return values
void —authorize2FaUser()
Authorizes an user that was provided by 2FA provider.
public
authorize2FaUser(string $userName) : void
Parameters
- $userName : string
-
user name
Tags
Return values
void —getId()
Returns a unique ID for the handler.
public
getId() : string
Tags
Return values
string —ID
getLoginName()
Returns the login name.
public
getLoginName() : string
Tags
Return values
string —login name
getLoginPassword()
Returns the login password.
public
getLoginPassword() : string
Tags
Return values
string —password
isAuthenticationSuccessful()
Returns if the authentication was successful.
public
isAuthenticationSuccessful() : bool
Tags
Return values
bool —authentication successful
managesAuthentication()
Returns if the login handler manages authentication on its own.
public
managesAuthentication() : bool
Tags
Return values
bool —manages authentication