PHP Interface Cartalyst\Sentinel\Checkpoints\CheckpointInterface

Mostra file Open project: cartalyst/sentinel

Public Methods

Method	Description
check ( Cartalyst\Sentinel\Users\UserInterface $user ) : boolean	Checkpoint for when a user is currently stored in the session.
fail ( Cartalyst\Sentinel\Users\UserInterface $user = null ) : void	Checkpoint for when a failed login attempt is logged. User is not always passed and the result of the method will not affect anything, as the login failed.
login ( Cartalyst\Sentinel\Users\UserInterface $user ) : boolean	Checkpoint after a user is logged in. Return false to deny persistence.

Method Details

check() public method

Checkpoint for when a user is currently stored in the session.

public check ( Cartalyst\Sentinel\Users\UserInterface $user ) : boolean
$user	Cartalyst\Sentinel\Users\UserInterface
return	boolean

fail() public method

Checkpoint for when a failed login attempt is logged. User is not always passed and the result of the method will not affect anything, as the login failed.

public fail ( Cartalyst\Sentinel\Users\UserInterface $user = null ) : void
$user	Cartalyst\Sentinel\Users\UserInterface
return	void

login() public method

Checkpoint after a user is logged in. Return false to deny persistence.

public login ( Cartalyst\Sentinel\Users\UserInterface $user ) : boolean
$user	Cartalyst\Sentinel\Users\UserInterface
return	boolean