PHP Class BookStack\Services\EmailConfirmationService

Show file Open project: ssddanbrown/bookstack

Protected Properties

Property Type Description
$db
$users

Public Methods

Method Description
__construct ( Connection $db, UserRepo $users ) EmailConfirmationService constructor.
createEmailConfirmation ( User $user ) : string Creates a new email confirmation in the database and returns the token.
deleteConfirmationsByUser ( User $user ) : mixed Delete all email confirmations that belong to a user.
getEmailConfirmationFromToken ( string $token ) : EmailConfirmation Gets an email confirmation by looking up the token, Ensures the token has not expired.
sendConfirmation ( User $user ) Create new confirmation for a user, Also removes any existing old ones.

Protected Methods

Method Description
getToken ( ) : string Creates a unique token within the email confirmation database.

Method Details

__construct() public method

EmailConfirmationService constructor.
public __construct ( Connection $db, UserRepo $users )
$db Illuminate\Database\Connection
$users BookStack\Repos\UserRepo

createEmailConfirmation() public method

Creates a new email confirmation in the database and returns the token.
public createEmailConfirmation ( User $user ) : string
$user BookStack\User
return string

deleteConfirmationsByUser() public method

Delete all email confirmations that belong to a user.
public deleteConfirmationsByUser ( User $user ) : mixed
$user BookStack\User
return mixed

getEmailConfirmationFromToken() public method

Gets an email confirmation by looking up the token, Ensures the token has not expired.
public getEmailConfirmationFromToken ( string $token ) : EmailConfirmation
$token string
return EmailConfirmation

getToken() protected method

Creates a unique token within the email confirmation database.
protected getToken ( ) : string
return string

sendConfirmation() public method

Create new confirmation for a user, Also removes any existing old ones.
public sendConfirmation ( User $user )
$user BookStack\User

Property Details

$db protected property

protected $db

$users protected property

protected $users