PHP Interface Cartalyst\Sentinel\Activations\ActivationRepositoryInterface

Show file Open project: cartalyst/sentinel Interface Usage Examples

Public Methods

Method Description
complete ( Cartalyst\Sentinel\Users\UserInterface $user, string $code ) : boolean Completes the activation for the given user.
completed ( Cartalyst\Sentinel\Users\UserInterface $user ) : Cartalyst\Sentinel\Activations\ActivationInterface | boolean Checks if a valid activation has been completed.
create ( Cartalyst\Sentinel\Users\UserInterface $user ) : Cartalyst\Sentinel\Activations\ActivationInterface Create a new activation record and code.
exists ( Cartalyst\Sentinel\Users\UserInterface $user, string $code = null ) : Cartalyst\Sentinel\Activations\ActivationInterface | boolean Checks if a valid activation for the given user exists.
remove ( Cartalyst\Sentinel\Users\UserInterface $user ) : boolean | null Remove an existing activation (deactivate).
removeExpired ( ) : integer Remove expired activation codes.

Method Details

complete() public method

Completes the activation for the given user.
public complete ( Cartalyst\Sentinel\Users\UserInterface $user, string $code ) : boolean
$user Cartalyst\Sentinel\Users\UserInterface
$code string
return boolean

completed() public method

Checks if a valid activation has been completed.
public completed ( Cartalyst\Sentinel\Users\UserInterface $user ) : Cartalyst\Sentinel\Activations\ActivationInterface | boolean
$user Cartalyst\Sentinel\Users\UserInterface
return Cartalyst\Sentinel\Activations\ActivationInterface | boolean

create() public method

Create a new activation record and code.
public create ( Cartalyst\Sentinel\Users\UserInterface $user ) : Cartalyst\Sentinel\Activations\ActivationInterface
$user Cartalyst\Sentinel\Users\UserInterface
return Cartalyst\Sentinel\Activations\ActivationInterface

exists() public method

Checks if a valid activation for the given user exists.
public exists ( Cartalyst\Sentinel\Users\UserInterface $user, string $code = null ) : Cartalyst\Sentinel\Activations\ActivationInterface | boolean
$user Cartalyst\Sentinel\Users\UserInterface
$code string
return Cartalyst\Sentinel\Activations\ActivationInterface | boolean

remove() public method

Remove an existing activation (deactivate).
public remove ( Cartalyst\Sentinel\Users\UserInterface $user ) : boolean | null
$user Cartalyst\Sentinel\Users\UserInterface
return boolean | null

removeExpired() public method

Remove expired activation codes.
public removeExpired ( ) : integer
return integer