PHP Class Cartalyst\Sentinel\Throttling\IlluminateThrottleRepository

Inheritance: implements Cartalyst\Sentinel\Throttling\ThrottleRepositoryInterface, use trait Cartalyst\Support\Traits\RepositoryTrait
Afficher le fichier Open project: cartalyst/sentinel

Protected Properties

Свойство Type Description
$globalInterval integer The interval which failed logins are checked, to prevent brute force.
$globalThresholds integer | array If an array is set, the key is the number of failed login attempts and the value is the delay in seconds before another login can occur. If an integer is set, it represents the number of attempts before throttling locks out in the current interval.
$globalThrottles Illuminate\Database\Eloquent\Collection Cached global throttles collection within the interval.
$ipInterval integer The interval at which point one IP address' failed logins are checked.
$ipThresholds integer | array Works identical to global thresholds, except specific to an IP address.
$ipThrottles array The cached IP address throttle collections within the interval.
$userInterval integer The interval at which point failed logins for one user are checked.
$userThresholds integer | array Works identical to global and IP address thresholds, regarding a user.
$userThrottles Illuminate\Database\Eloquent\Collection The cached user throttle collections within the interval.

Méthodes publiques

Méthode Description
__construct ( string $model = 'Cartalyst\Sentinel\Throttling\EloquentThrottle', integer $globalInterval = null, integer | array $globalThresholds = null, integer $ipInterval = null, integer | array $ipThresholds = null, integer $userInterval = null, integer | array $userThresholds = null ) : void Create a new Illuminate throttle repository.
getGlobalInterval ( ) : integer Returns the global interval.
getGlobalThresholds ( ) : integer | array Returns the global thresholds.
getIpInterval ( ) : integer Returns the IP address interval.
getIpThresholds ( ) : integer | array Returns the IP address thresholds.
getUserInterval ( ) : integer Returns the user interval.
getUserThresholds ( ) : integer | array Returns the user thresholds.
globalDelay ( ) {@inheritDoc}
ipDelay ( $ipAddress ) {@inheritDoc}
log ( $ipAddress = null, Cartalyst\Sentinel\Users\UserInterface $user = null ) {@inheritDoc}
setGlobalInterval ( integer $globalInterval ) : void Sets the global interval.
setGlobalThresholds ( integer | array $globalThresholds ) : void Sets the global thresholds.
setIpInterval ( integer $ipInterval ) : void Sets the IP address interval.
setIpThresholds ( integer | array $ipThresholds ) : void Sets the IP address thresholds.
setUserInterval ( integer $userInterval ) : void Sets the user interval.
setUserThresholds ( integer | array $userThresholds ) : void Sets the user thresholds.
userDelay ( Cartalyst\Sentinel\Users\UserInterface $user ) {@inheritDoc}

Méthodes protégées

Méthode Description
delay ( string $type, mixed $argument = null ) : integer Returns a delay for the given type.
getGlobalThrottles ( ) : Illuminate\Database\Eloquent\Collection Returns the global throttles collection.
getIpThrottles ( string $ipAddress ) : Illuminate\Database\Eloquent\Collection Returns the IP address throttles collection.
getUserThrottles ( Cartalyst\Sentinel\Users\UserInterface $user ) : Illuminate\Database\Eloquent\Collection Returns the user throttles collection.
loadGlobalThrottles ( ) : Illuminate\Database\Eloquent\Collection Loads and returns the global throttles collection.
loadIpThrottles ( string $ipAddress ) : Illuminate\Database\Eloquent\Collection Loads and returns the IP address throttles collection.
loadUserThrottles ( Cartalyst\Sentinel\Users\UserInterface $user ) : Illuminate\Database\Eloquent\Collection Loads and returns the user throttles collection.
secondsToFree ( EloquentThrottle $throttle, integer $interval ) : integer Returns the seconds to free based on the given throttle and the presented delay in seconds, by comparing it to now.

Method Details

__construct() public méthode

Create a new Illuminate throttle repository.
public __construct ( string $model = 'Cartalyst\Sentinel\Throttling\EloquentThrottle', integer $globalInterval = null, integer | array $globalThresholds = null, integer $ipInterval = null, integer | array $ipThresholds = null, integer $userInterval = null, integer | array $userThresholds = null ) : void
$model string
$globalInterval integer
$globalThresholds integer | array
$ipInterval integer
$ipThresholds integer | array
$userInterval integer
$userThresholds integer | array
Résultat void

delay() protected méthode

Returns a delay for the given type.
protected delay ( string $type, mixed $argument = null ) : integer
$type string
$argument mixed
Résultat integer

getGlobalInterval() public méthode

Returns the global interval.
public getGlobalInterval ( ) : integer
Résultat integer

getGlobalThresholds() public méthode

Returns the global thresholds.
public getGlobalThresholds ( ) : integer | array
Résultat integer | array

getGlobalThrottles() protected méthode

Returns the global throttles collection.
protected getGlobalThrottles ( ) : Illuminate\Database\Eloquent\Collection
Résultat Illuminate\Database\Eloquent\Collection

getIpInterval() public méthode

Returns the IP address interval.
public getIpInterval ( ) : integer
Résultat integer

getIpThresholds() public méthode

Returns the IP address thresholds.
public getIpThresholds ( ) : integer | array
Résultat integer | array

getIpThrottles() protected méthode

Returns the IP address throttles collection.
protected getIpThrottles ( string $ipAddress ) : Illuminate\Database\Eloquent\Collection
$ipAddress string
Résultat Illuminate\Database\Eloquent\Collection

getUserInterval() public méthode

Returns the user interval.
public getUserInterval ( ) : integer
Résultat integer

getUserThresholds() public méthode

Returns the user thresholds.
public getUserThresholds ( ) : integer | array
Résultat integer | array

getUserThrottles() protected méthode

Returns the user throttles collection.
protected getUserThrottles ( Cartalyst\Sentinel\Users\UserInterface $user ) : Illuminate\Database\Eloquent\Collection
$user Cartalyst\Sentinel\Users\UserInterface
Résultat Illuminate\Database\Eloquent\Collection

globalDelay() public méthode

{@inheritDoc}
public globalDelay ( )

ipDelay() public méthode

{@inheritDoc}
public ipDelay ( $ipAddress )

loadGlobalThrottles() protected méthode

Loads and returns the global throttles collection.
protected loadGlobalThrottles ( ) : Illuminate\Database\Eloquent\Collection
Résultat Illuminate\Database\Eloquent\Collection

loadIpThrottles() protected méthode

Loads and returns the IP address throttles collection.
protected loadIpThrottles ( string $ipAddress ) : Illuminate\Database\Eloquent\Collection
$ipAddress string
Résultat Illuminate\Database\Eloquent\Collection

loadUserThrottles() protected méthode

Loads and returns the user throttles collection.
protected loadUserThrottles ( Cartalyst\Sentinel\Users\UserInterface $user ) : Illuminate\Database\Eloquent\Collection
$user Cartalyst\Sentinel\Users\UserInterface
Résultat Illuminate\Database\Eloquent\Collection

log() public méthode

{@inheritDoc}
public log ( $ipAddress = null, Cartalyst\Sentinel\Users\UserInterface $user = null )
$user Cartalyst\Sentinel\Users\UserInterface

secondsToFree() protected méthode

Returns the seconds to free based on the given throttle and the presented delay in seconds, by comparing it to now.
protected secondsToFree ( EloquentThrottle $throttle, integer $interval ) : integer
$throttle EloquentThrottle
$interval integer
Résultat integer

setGlobalInterval() public méthode

Sets the global interval.
public setGlobalInterval ( integer $globalInterval ) : void
$globalInterval integer
Résultat void

setGlobalThresholds() public méthode

Sets the global thresholds.
public setGlobalThresholds ( integer | array $globalThresholds ) : void
$globalThresholds integer | array
Résultat void

setIpInterval() public méthode

Sets the IP address interval.
public setIpInterval ( integer $ipInterval ) : void
$ipInterval integer
Résultat void

setIpThresholds() public méthode

Sets the IP address thresholds.
public setIpThresholds ( integer | array $ipThresholds ) : void
$ipThresholds integer | array
Résultat void

setUserInterval() public méthode

Sets the user interval.
public setUserInterval ( integer $userInterval ) : void
$userInterval integer
Résultat void

setUserThresholds() public méthode

Sets the user thresholds.
public setUserThresholds ( integer | array $userThresholds ) : void
$userThresholds integer | array
Résultat void

userDelay() public méthode

{@inheritDoc}
public userDelay ( Cartalyst\Sentinel\Users\UserInterface $user )
$user Cartalyst\Sentinel\Users\UserInterface

Property Details

$globalInterval protected_oe property

The interval which failed logins are checked, to prevent brute force.
protected int $globalInterval
Résultat integer

$globalThresholds protected_oe property

If an array is set, the key is the number of failed login attempts and the value is the delay in seconds before another login can occur. If an integer is set, it represents the number of attempts before throttling locks out in the current interval.
protected int|array $globalThresholds
Résultat integer | array

$globalThrottles protected_oe property

Cached global throttles collection within the interval.
protected Collection,Illuminate\Database\Eloquent $globalThrottles
Résultat Illuminate\Database\Eloquent\Collection

$ipInterval protected_oe property

The interval at which point one IP address' failed logins are checked.
protected int $ipInterval
Résultat integer

$ipThresholds protected_oe property

Works identical to global thresholds, except specific to an IP address.
protected int|array $ipThresholds
Résultat integer | array

$ipThrottles protected_oe property

The cached IP address throttle collections within the interval.
protected array $ipThrottles
Résultat array

$userInterval protected_oe property

The interval at which point failed logins for one user are checked.
protected int $userInterval
Résultat integer

$userThresholds protected_oe property

Works identical to global and IP address thresholds, regarding a user.
protected int|array $userThresholds
Résultat integer | array

$userThrottles protected_oe property

The cached user throttle collections within the interval.
protected Collection,Illuminate\Database\Eloquent $userThrottles
Résultat Illuminate\Database\Eloquent\Collection