| Methods |
public
|
init()
Initializes Module.
|
#
|
public
|
EntryConfirmRecoveryEmail()
|
#
|
public
|
GetSettings(): array
Obtains list of module settings for authenticated user.
Obtains list of module settings for authenticated user.
Overrides
|
#
|
public
|
UpdateSettings(string $RecoveryEmail = null, string $Password = null): boolean|string
Updates per user settings.
Updates per user settings.
Throws
|
#
|
public
|
UpdateAdminSettings(
$RecoveryLinkLifetimeMinutes,
$NotificationEmail,
$NotificationType,
$NotificationHost = null,
$NotificationPort = null,
$NotificationSMTPSecure = null,
$NotificationUseAuth = null,
$NotificationLogin = null,
$NotificationPassword = null,
): boolean|string
Updates per user settings.
Updates per user settings.
Throws
|
#
|
public
|
SetRecoveryEmail($UserPublicId = null, $RecoveryEmail = null, $SkipEmailConfirmation = false)
|
#
|
public
|
GetStarredRecoveryEmailAddress(string $UserPublicId): string
Get recovery email address partly replaced with stars.
Get recovery email address partly replaced with stars.
|
#
|
public
|
SendPasswordResetEmail(string $UserPublicId): boolean
Creates a recovery link and sends it to recovery email of the user with specified public ID.
Creates a recovery link and sends it to recovery email of the user with specified public ID.
Throws
|
#
|
public
|
GetUserPublicId(string $Hash): string
Returns public id of user obtained from the hash.
Returns public id of user obtained from the hash.
Parameters
| $Hash |
Hash with information about user.
|
|
#
|
public
|
ChangePassword(string $Hash, string $NewPassword): boolean
Changes password if hash is valid.
Changes password if hash is valid.
Throws
|
#
|