class RateLimiter (View source)

Traits

A class that can be instantiated or replaced via DI

Methods

static Injectable
create(array ...$args)

An implementation of the factory method, allows you to create an instance of a class

static Injectable
singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

__construct(string $identifier, int $maxAttempts, int $decay)

RateLimiter constructor.

CacheInterface
getCache()

No description

$this
setCache(CacheInterface $cache)

No description

string
getIdentifier()

No description

$this
setIdentifier(string $identifier)

No description

int
getMaxAttempts()

No description

$this
setMaxAttempts(int $maxAttempts)

No description

int
getDecay()

No description

$this
setDecay(int $decay)

No description

int
getNumAttempts()

No description

int
getNumAttemptsRemaining()

No description

int
getTimeToReset()

No description

$this
clearAttempts()

No description

$this
hit()

Store a hit in the rate limit cache

bool
canAccess()

No description

Details

static Injectable create(array ...$args)

An implementation of the factory method, allows you to create an instance of a class

This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.

This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create(SiteTree::class); $list = SiteTree::get();

Parameters

array ...$args

Return Value

Injectable

static Injectable singleton(string $class = null)

Creates a class instance by the "singleton" design pattern.

It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).

Parameters

string $class

Optional classname to create, if the called class should not be used

Return Value

Injectable

The singleton instance

__construct(string $identifier, int $maxAttempts, int $decay)

RateLimiter constructor.

Parameters

string $identifier
int $maxAttempts
int $decay

CacheInterface getCache()

Return Value

CacheInterface

$this setCache(CacheInterface $cache)

Parameters

CacheInterface $cache

Return Value

$this

string getIdentifier()

Return Value

string

$this setIdentifier(string $identifier)

Parameters

string $identifier

Return Value

$this

int getMaxAttempts()

Return Value

int

$this setMaxAttempts(int $maxAttempts)

Parameters

int $maxAttempts

Return Value

$this

int getDecay()

Return Value

int

$this setDecay(int $decay)

Parameters

int $decay

Return Value

$this

int getNumAttempts()

Return Value

int

int getNumAttemptsRemaining()

Return Value

int

int getTimeToReset()

Return Value

int

$this clearAttempts()

Return Value

$this

$this hit()

Store a hit in the rate limit cache

Return Value

$this

bool canAccess()

Return Value

bool