ThrottleRequestsWithRedis
класс ThrottleRequestsWithRedis расширяет ThrottleRequests (View source)
Черты
| InteractsWithTime |
Свойства
| protected RateLimiter | $limiter | Экземпляр ограничителя скорости. | из ThrottleRequests |
| static protected bool | $shouldHashKeys | Указывает, следует ли хешировать ключи ограничителя скорости. | из ThrottleRequests |
| protected Factory | $redis | Реализация фабрики Redis. | |
| array | $decaysAt | Метка времени окончания текущего периода по ключу. | |
| array | $remaining | Количество оставшихся слотов по ключу. |
Методы
| int | secondsUntil(DateTimeInterface|DateInterval|int $delay)
Получить количество секунд до заданной даты и времени. | из InteractsWithTime |
| int | availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Получить метку времени UNIX "доступно в". | из InteractsWithTime |
| DateTimeInterface|int | parseDateInterval(DateTimeInterface|DateInterval|int $delay)
Если заданное значение является интервалом, преобразуйте его в экземпляр DateTime. | из InteractsWithTime |
| int | currentTime()
Получить текущее системное время в виде метки времени UNIX. | из InteractsWithTime |
| void | __construct(RateLimiter $limiter, Factory $redis)
Создать новый ограничитель запросов. | |
| static string | using(string $name)
Указать именованный ограничитель скорости для использования в промежуточном ПО. | из ThrottleRequests |
| static string | with(int $maxAttempts = 60, int $decayMinutes = 1, string $prefix = '')
Указать конфигурацию ограничителя скорости для промежуточного ПО. | из ThrottleRequests |
| Response | handle(Request $request, Closure $next, int|string $maxAttempts = 60, float|int $decayMinutes = 1, string $prefix = '')
Обработать входящий запрос. | из ThrottleRequests |
| Response | handleRequestUsingNamedLimiter(Request $request, Closure $next, string $limiterName, Closure $limiter)
Обработать входящий запрос. | из ThrottleRequests |
| Response | handleRequest(Request $request, Closure $next, array $limits)
Обработать входящий запрос. | |
| int | resolveMaxAttempts(Request $request, int|string $maxAttempts)
Определить количество попыток, если пользователь аутентифицирован или нет. | из ThrottleRequests |
| string | resolveRequestSignature(Request $request)
Определить сигнатуру запроса. | из ThrottleRequests |
| ThrottleRequestsException|HttpResponseException | buildException(Request $request, string $key, int $maxAttempts, callable|null $responseCallback = null)
Создать исключение "слишком много попыток". | из ThrottleRequests |
| int | getTimeUntilNextRetry(string $key)
Получить количество секунд до освобождения блокировки. | |
| Response | addHeaders(Response $response, int $maxAttempts, int $remainingAttempts, int|null $retryAfter = null)
Добавить информацию о заголовке лимита в заданный ответ. | из ThrottleRequests |
| array | getHeaders(int $maxAttempts, int $remainingAttempts, int|null $retryAfter = null, Response|null $response = null)
Получить информацию о заголовках лимита. | из ThrottleRequests |
| int | calculateRemainingAttempts(string $key, int $maxAttempts, int|null $retryAfter = null)
Рассчитать количество оставшихся попыток. | |
| static void | shouldHashKeys(bool $shouldHashKeys = true)
Указать, следует ли хешировать ключи ограничителя скорости. | из ThrottleRequests |
| mixed | tooManyAttempts(string $key, int $maxAttempts, int $decayMinutes)
Определить, был ли заданный ключ "достучен" слишком много раз. | |
| Connection | getRedisConnection()
Получить подключение Redis, которое должно использоваться для ограничения. |
Подробности
protected int secondsUntil(DateTimeInterface|DateInterval|int $delay)
Получить количество секунд до заданной даты DateTime.
protected int availableAt(DateTimeInterface|DateInterval|int $delay = 0)
Получить отметку времени "доступно в" в формате UNIX.
protected DateTimeInterface|int parseDateInterval(DateTimeInterface|DateInterval|int $delay)
Если заданное значение является интервалом, преобразуйте его в экземпляр DateTime.
protected int currentTime()
Получить текущее системное время как отметку времени в формате UNIX.
void __construct(RateLimiter $limiter, Factory $redis)
Создать новый ограничитель запросов.
static string using(string $name)
Указать используемый ограничитель запросов по имени.
static string with(int $maxAttempts = 60, int $decayMinutes = 1, string $prefix = '')
Указать конфигурацию ограничителя запросов для middleware.
Response handle(Request $request, Closure $next, int|string $maxAttempts = 60, float|int $decayMinutes = 1, string $prefix = '')
Обработать входящий запрос.
protected Response handleRequestUsingNamedLimiter(Request $request, Closure $next, string $limiterName, Closure $limiter)
Обработать входящий запрос.
protected Response handleRequest(Request $request, Closure $next, array $limits)
Обработать входящий запрос.
protected int resolveMaxAttempts(Request $request, int|string $maxAttempts)
Определить количество попыток, если пользователь аутентифицирован или нет.
protected string resolveRequestSignature(Request $request)
Определить подпись запроса.
protected ThrottleRequestsException|HttpResponseException buildException(Request $request, string $key, int $maxAttempts, callable|null $responseCallback = null)
Создать исключение "слишком много попыток".
protected int getTimeUntilNextRetry(string $key)
Получить количество секунд до освобождения блокировки.
protected Response addHeaders(Response $response, int $maxAttempts, int $remainingAttempts, int|null $retryAfter = null)
Добавить информацию о лимите в заголовки данного ответа.
protected array getHeaders(int $maxAttempts, int $remainingAttempts, int|null $retryAfter = null, Response|null $response = null)
Получить информацию о заголовках лимита.
protected int calculateRemainingAttempts(string $key, int $maxAttempts, int|null $retryAfter = null)
Вычислить оставшееся количество попыток.
static void shouldHashKeys(bool $shouldHashKeys = true)
Указать, нужно ли хешировать ключи лимита.
protected mixed tooManyAttempts(string $key, int $maxAttempts, int $decayMinutes)
Определить, превышено ли количество попыток для данного ключа.
protected Connection getRedisConnection()
Получить соединение с Redis, которое следует использовать для лимитирования.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Routing/Middleware/ThrottleRequestsWithRedis.html
