PHP Класс Cartalyst\Sentinel\Checkpoints\ThrottleCheckpoint

Наследование: implements Cartalyst\Sentinel\Checkpoints\CheckpointInterface
Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$ipAddress string The cached IP address, used for checkpoints checks.
$throttle Cartalyst\Sentinel\Throttling\ThrottleRepositoryInterface The throttle repository.

Открытые методы

Метод Описание
__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}

Защищенные методы

Метод Описание
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.

Описание методов

__construct() публичный метод

Constructor.
public __construct ( Cartalyst\Sentinel\Throttling\ThrottleRepositoryInterface $throttle, string $ipAddress = null ) : void
$throttle Cartalyst\Sentinel\Throttling\ThrottleRepositoryInterface
$ipAddress string
Результат void

check() публичный метод

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

checkThrottling() защищенный метод

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
Результат boolean

fail() публичный метод

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

login() публичный метод

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

throwException() защищенный метод

Throws a throttling exception.
protected throwException ( string $message, string $type, integer $delay )
$message string
$type string
$delay integer

Описание свойств

$ipAddress защищенное свойство

The cached IP address, used for checkpoints checks.
protected string $ipAddress
Результат string

$throttle защищенное свойство

The throttle repository.
protected ThrottleRepositoryInterface,Cartalyst\Sentinel\Throttling $throttle
Результат Cartalyst\Sentinel\Throttling\ThrottleRepositoryInterface