Neuron-PHP

IPasswordResetter

Password reset service interface

Table of Contents

Methods

cleanupExpiredTokens()  : int
Clean up expired password reset tokens
requestReset()  : bool
Request a password reset for the given email
resetPassword()  : bool
Reset a user's password using a token
setTokenExpirationMinutes()  : self
Set token expiration time in minutes
validateToken()  : PasswordResetToken|null
Validate a password reset token

Methods

cleanupExpiredTokens()

Clean up expired password reset tokens

public cleanupExpiredTokens() : int
Return values
int

Number of tokens deleted

requestReset()

Request a password reset for the given email

public requestReset(string $email) : bool
Parameters
$email : string

User email address

Return values
bool

True on success

resetPassword()

Reset a user's password using a token

public resetPassword(string $plainToken, string $newPassword) : bool
Parameters
$plainToken : string

The plain token string

$newPassword : string

The new password

Return values
bool

True on success

setTokenExpirationMinutes()

Set token expiration time in minutes

public setTokenExpirationMinutes(int $minutes) : self
Parameters
$minutes : int

Expiration time in minutes

Return values
self

        
On this page

Search results