PHP Interface Cartalyst\Sentinel\Throttling\ThrottleRepositoryInterface

Show file Open project: cartalyst/sentinel Interface Usage Examples

Public Methods

Method	Description
globalDelay ( ) : integer	Returns the global throttling delay, in seconds.
ipDelay ( string $ipAddress ) : integer	Returns the IP address throttling delay, in seconds.
log ( string $ipAddress = null, Cartalyst\Sentinel\Users\UserInterface $user = null ) : void	Logs a new throttling entry.
userDelay ( Cartalyst\Sentinel\Users\UserInterface $user ) : integer	Returns the throttling delay for the given user, in seconds.

Method Details

globalDelay() public method

Returns the global throttling delay, in seconds.

public globalDelay ( ) : integer
return	integer

ipDelay() public method

Returns the IP address throttling delay, in seconds.

public ipDelay ( string $ipAddress ) : integer
$ipAddress	string
return	integer

log() public method

Logs a new throttling entry.

public log ( string $ipAddress = null, Cartalyst\Sentinel\Users\UserInterface $user = null ) : void
$ipAddress	string
$user	Cartalyst\Sentinel\Users\UserInterface
return	void

userDelay() public method

Returns the throttling delay for the given user, in seconds.

public userDelay ( Cartalyst\Sentinel\Users\UserInterface $user ) : integer
$user	Cartalyst\Sentinel\Users\UserInterface
return	integer