1. class
  2. Poweradmin
  3. \
  4. Domain
  5. \
  6. Model
  7. \
  8. UserMfa

UserMfa

class UserMfa (View source)

Constants

TYPE_APP

TYPE_EMAIL

Methods

__construct(int $id, int $userId, bool $enabled, string|null $secret, string|null $recoveryCodes, string $type, DateTime|null $lastUsedAt, DateTime $createdAt, DateTime|null $updatedAt, string|null $verificationData = null)

No description

static UserMfa
create(int $userId, bool $enabled = false, string|null $secret = null, string|null $recoveryCodes = null, string $type = self::TYPE_APP, string|null $verificationData = null)

No description

int
getId()

No description

int
getUserId()

No description

bool
isEnabled()

No description

void
enable()

No description

void
disable()

No description

string|null
getSecret()

No description

void
setSecret(string|null $secret)

No description

string|null
getRecoveryCodes()

No description

array
getRecoveryCodesAsArray()

No description

void
setRecoveryCodes(array $recoveryCodes)

No description

void
setVerificationMetadata(array $metadata)

Store verification metadata for email-based MFA

void
setRecoveryCodesRaw(string $jsonString)

Set raw JSON string for recovery codes (for backward compatibility)

string|null
getVerificationData()

Get verification data

array
getVerificationDataAsArray()

Get verification data as array

void
setVerificationData(array $data)

Set verification data

void
setVerificationDataRaw(string $jsonString)

Set raw verification data (JSON string)

string
getType()

No description

void
setType(string $type)

No description

MfaFactorType|null
getFactorType()

The configured factor as an enum, or null for a type this build no longer knows.

DateTime|null
getLastUsedAt()

No description

void
updateLastUsed()

No description

DateTime
getCreatedAt()

No description

DateTime|null
getUpdatedAt()

No description

bool
validateRecoveryCode(string $code)

Check if a recovery code is valid and remove it from the list if it is

array
generateRecoveryCodes(int $count = 10, int $length = 10)

Generate new recovery codes

Details

at line 34
__construct(int $id, int $userId, bool $enabled, string|null $secret, string|null $recoveryCodes, string $type, DateTime|null $lastUsedAt, DateTime $createdAt, DateTime|null $updatedAt, string|null $verificationData = null)

No description

Parameters

int $id
int $userId
bool $enabled
string|null $secret
string|null $recoveryCodes
string $type
DateTime|null $lastUsedAt
DateTime $createdAt
DateTime|null $updatedAt
string|null $verificationData

at line 48
static UserMfa create(int $userId, bool $enabled = false, string|null $secret = null, string|null $recoveryCodes = null, string $type = self::TYPE_APP, string|null $verificationData = null)

No description

Parameters

int $userId
bool $enabled
string|null $secret
string|null $recoveryCodes
string $type
string|null $verificationData

Return Value

UserMfa

at line 70
int getId()

No description

Return Value

int

at line 75
int getUserId()

No description

Return Value

int

at line 80
bool isEnabled()

No description

Return Value

bool

at line 85
void enable()

No description

Return Value

void

at line 91
void disable()

No description

Return Value

void

at line 97
string|null getSecret()

No description

Return Value

string|null

at line 102
void setSecret(string|null $secret)

No description

Parameters

string|null $secret

Return Value

void

at line 108
string|null getRecoveryCodes()

No description

Return Value

string|null

at line 113
array getRecoveryCodesAsArray()

No description

Return Value

array

at line 122
void setRecoveryCodes(array $recoveryCodes)

No description

Parameters

array $recoveryCodes

Return Value

void

at line 133
void setVerificationMetadata(array $metadata)

Store verification metadata for email-based MFA

Parameters

array $metadata

The verification metadata

Return Value

void

at line 144
void setRecoveryCodesRaw(string $jsonString)

Set raw JSON string for recovery codes (for backward compatibility)

Parameters

string $jsonString

JSON string to set

Return Value

void

at line 155
string|null getVerificationData()

Get verification data

Return Value

string|null

The verification data

at line 165
array getVerificationDataAsArray()

Get verification data as array

Return Value

array

The verification data as array

at line 179
void setVerificationData(array $data)

Set verification data

Parameters

array $data

The verification data to set

Return Value

void

at line 190
void setVerificationDataRaw(string $jsonString)

Set raw verification data (JSON string)

Parameters

string $jsonString

The verification data as JSON string

Return Value

void

at line 196
string getType()

No description

Return Value

string

at line 201
void setType(string $type)

No description

Parameters

string $type

Return Value

void

at line 214
MfaFactorType|null getFactorType()

The configured factor as an enum, or null for a type this build no longer knows.

Return Value

MfaFactorType|null

at line 219
DateTime|null getLastUsedAt()

No description

Return Value

DateTime|null

at line 224
void updateLastUsed()

No description

Return Value

void

at line 230
DateTime getCreatedAt()

No description

Return Value

DateTime

at line 235
DateTime|null getUpdatedAt()

No description

Return Value

DateTime|null

at line 246
bool validateRecoveryCode(string $code)

Check if a recovery code is valid and remove it from the list if it is

Parameters

string $code

The recovery code to validate

Return Value

bool

True if the code is valid, false otherwise

at line 268
array generateRecoveryCodes(int $count = 10, int $length = 10)

Generate new recovery codes

Parameters

int $count

Number of recovery codes to generate
int $length

Length of each recovery code in bytes (before hex encoding)

Return Value

array

The generated recovery codes