RateLimiterFactory 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<string|int, mixed>
$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<string|int, mixed>
isIpExcluded()  : bool

Properties

$config read-only

protected array<string|int, mixed> $config = []

Methods

create()

public create([string|null $key = null ]) : LimiterInterface
Parameters
$key : string|null = null
Return values
LimiterInterface

createLimiter()

Create a limiter with custom configuration.

public createLimiter(array<string|int, mixed> $config[, string|null $key = null ]) : LimiterInterface
Parameters
$config : array<string|int, mixed>
$key : string|null = null
Return values
LimiterInterface

createLoginRateLimiter()

Create a limiter for user login.

public createLoginRateLimiter(ServerRequestInterface $request, string $loginType) : LimiterInterface
Parameters
$request : ServerRequestInterface
$loginType : string
Return values
LimiterInterface

createRequestBasedLimiter()

Create a limiter based on the request input.

public createRequestBasedLimiter(ServerRequestInterface $request, array<string|int, mixed> $configuration) : LimiterInterface
Parameters
$request : ServerRequestInterface
$configuration : array<string|int, mixed>
Return values
LimiterInterface

applyConfigOverrides()

protected applyConfigOverrides(array<string|int, mixed> $config) : array<string|int, mixed>
Parameters
$config : array<string|int, mixed>
Return values
array<string|int, mixed>

isIpExcluded()

protected isIpExcluded(string $loginType, string $remoteAddress) : bool
Parameters
$loginType : string
$remoteAddress : string
Return values
bool 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results