RateLimiterFactory
readonly class \
- Implements
- RateLimiterFactoryInterface
Attributes
- #[Autoconfigure]
- $public: true
- $shared: false
Table of Contents
Interfaces
- RateLimiterFactoryInterface
- TYPO3's own rate limiter factory interface extending Symfony's RateLimiterFactoryInterface with additional convenience methods for request-based and login rate limiting.
Properties
- $config : array
- $storage : CachingFrameworkStorage
Methods
- __construct() : mixed
- create() : LimiterInterface
- createLimiter() : LimiterInterface
- Create a limiter with custom configuration.
- createLoginRateLimiter() : LimiterInterface
- Create a limiter for user login.
- createRequestBasedLimiter() : LimiterInterface
- Create a limiter based on the request input.
- applyConfigOverrides() : array
- isIpExcluded() : bool
Properties
$config
protected
array
$config
= []
$storage
protected
CachingFrameworkStorage
$storage
Methods
__construct()
public
__construct(CachingFrameworkStorage $storage[, array $config = [] ]) : mixed
Parameters
- $storage : CachingFrameworkStorage
- $config : array = []
create()
public
create([string|null $key = null ]) : LimiterInterface
Parameters
- $key : string|null = null
Return values
LimiterInterfacecreateLimiter()
Create a limiter with custom configuration.
public
createLimiter(array $config[, string|null $key = null ]) : LimiterInterface
Parameters
- $config : array
- $key : string|null = null
Return values
LimiterInterfacecreateLoginRateLimiter()
Create a limiter for user login.
public
createLoginRateLimiter(ServerRequestInterface $request, string $loginType) : LimiterInterface
Parameters
- $request : ServerRequestInterface
- $loginType : string
Return values
LimiterInterfacecreateRequestBasedLimiter()
Create a limiter based on the request input.
public
createRequestBasedLimiter(ServerRequestInterface $request, array $configuration) : LimiterInterface
Parameters
- $request : ServerRequestInterface
- $configuration : array
Return values
LimiterInterfaceapplyConfigOverrides()
protected
applyConfigOverrides(array $config) : array
Parameters
- $config : array
Return values
arrayisIpExcluded()
protected
isIpExcluded(string $loginType, string $remoteAddress) : bool
Parameters
- $loginType : string
- $remoteAddress : string