PHP Interface Cartalyst\Sentinel\Reminders\ReminderRepositoryInterface

Show file Open project: cartalyst/sentinel Interface Usage Examples

Public Methods

Method	Description
complete ( Cartalyst\Sentinel\Users\UserInterface $user, string $code, string $password ) : boolean	Complete reminder for the given user.
create ( Cartalyst\Sentinel\Users\UserInterface $user ) : string	Create a new reminder record and code.
exists ( Cartalyst\Sentinel\Users\UserInterface $user, string $code = null ) : boolean	Check if a valid reminder exists.
removeExpired ( ) : integer	Remove expired reminder codes.

Method Details

complete() public method

Complete reminder for the given user.

public complete ( Cartalyst\Sentinel\Users\UserInterface $user, string $code, string $password ) : boolean
$user	Cartalyst\Sentinel\Users\UserInterface
$code	string
$password	string
return	boolean

create() public method

Create a new reminder record and code.

public create ( Cartalyst\Sentinel\Users\UserInterface $user ) : string
$user	Cartalyst\Sentinel\Users\UserInterface
return	string

exists() public method

Check if a valid reminder exists.

public exists ( Cartalyst\Sentinel\Users\UserInterface $user, string $code = null ) : boolean
$user	Cartalyst\Sentinel\Users\UserInterface
$code	string
return	boolean

removeExpired() public method

Remove expired reminder codes.

public removeExpired ( ) : integer
return	integer