Documentation

MFAInterface

Table of Contents

Methods

checkMFAData()  : bool
getFormUrl()  : string
Returns an appropriate URL for a user to go to to either provide or set-up this MFA after correctly entering their username and password.
processMFAAttempt()  : bool
Handle the User.login request with MFA class + data.
userHasCompletedSetup()  : bool
Returns whether this MFA is configured for the user.

Methods

checkMFAData()

public checkMFAData(mixed $data) : bool
Parameters
$data : mixed
Return values
bool

getFormUrl()

Returns an appropriate URL for a user to go to to either provide or set-up this MFA after correctly entering their username and password.

public getFormUrl() : string
Return values
string

processMFAAttempt()

Handle the User.login request with MFA class + data.

public processMFAAttempt(array<string|int, mixed> $pending, mixed $code) : bool
Parameters
$pending : array<string|int, mixed>
$code : mixed
Return values
bool

Should login continue?

userHasCompletedSetup()

Returns whether this MFA is configured for the user.

public userHasCompletedSetup() : bool
Return values
bool

        
On this page

Search results