PHP Class Cartalyst\Sentinel\Checkpoints\ThrottleCheckpoint

Inheritance: implements Cartalyst\Sentinel\Checkpoints\CheckpointInterface

Protected Properties

Property	Type	Description
$ipAddress	string	The cached IP address, used for checkpoints checks.
$throttle	Cartalyst\Sentinel\Throttling\ThrottleRepositoryInterface	The throttle repository.

Method	Description
__construct ( Cartalyst\Sentinel\Throttling\ThrottleRepositoryInterface $throttle, string $ipAddress = null ) : void	Constructor.
check ( Cartalyst\Sentinel\Users\UserInterface $user )	{@inheritDoc}
fail ( Cartalyst\Sentinel\Users\UserInterface $user = null )	{@inheritDoc}
login ( Cartalyst\Sentinel\Users\UserInterface $user )	{@inheritDoc}

Method	Description
checkThrottling ( string $action, Cartalyst\Sentinel\Users\UserInterface $user = null ) : boolean	Checks the throttling status of the given user.
throwException ( string $message, string $type, integer $delay )	Throws a throttling exception.

Constructor.

public __construct ( Cartalyst\Sentinel\Throttling\ThrottleRepositoryInterface $throttle, string $ipAddress = null ) : void
$throttle	Cartalyst\Sentinel\Throttling\ThrottleRepositoryInterface
$ipAddress	string
return	void

{@inheritDoc}

public check ( Cartalyst\Sentinel\Users\UserInterface $user )
$user	Cartalyst\Sentinel\Users\UserInterface

Checks the throttling status of the given user.

protected checkThrottling ( string $action, Cartalyst\Sentinel\Users\UserInterface $user = null ) : boolean
$action	string
$user	Cartalyst\Sentinel\Users\UserInterface
return	boolean

{@inheritDoc}

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

{@inheritDoc}

public login ( Cartalyst\Sentinel\Users\UserInterface $user )
$user	Cartalyst\Sentinel\Users\UserInterface

Throws a throttling exception.

protected throwException ( string $message, string $type, integer $delay )
$message	string
$type	string
$delay	integer

The cached IP address, used for checkpoints checks.

protected string $ipAddress
return	string

The throttle repository.

protected ThrottleRepositoryInterface,Cartalyst\Sentinel\Throttling $throttle
return	Cartalyst\Sentinel\Throttling\ThrottleRepositoryInterface