class RateLimiter (View source)

Traits

A class that can be instantiated or replaced via DI

Methods

public static 
create(mixed ...$args)

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

public static 
singleton(string $class = null)

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

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

RateLimiter constructor.

public
CacheInterface
getCache()

No description

public
$this
setCache(CacheInterface $cache)

No description

public
string
getIdentifier()

No description

public
$this
setIdentifier(string $identifier)

No description

public
int
getMaxAttempts()

No description

public
$this
setMaxAttempts(int $maxAttempts)

No description

public
int
getDecay()

No description

public
$this
setDecay(int $decay)

No description

public
int
getNumAttempts()

No description

public
int
getNumAttemptsRemaining()

No description

public
int
getTimeToReset()

No description

public
$this
clearAttempts()

No description

public
$this
hit()

Store a hit in the rate limit cache

public
bool
canAccess()

No description

Details

static Injectable create(mixed ...$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

mixed ...$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()

No description

Return Value

CacheInterface

$this setCache(CacheInterface $cache)

No description

Parameters

CacheInterface $cache

Return Value

$this

string getIdentifier()

No description

Return Value

string

$this setIdentifier(string $identifier)

No description

Parameters

string $identifier

Return Value

$this

int getMaxAttempts()

No description

Return Value

int

$this setMaxAttempts(int $maxAttempts)

No description

Parameters

int $maxAttempts

Return Value

$this

int getDecay()

No description

Return Value

int

$this setDecay(int $decay)

No description

Parameters

int $decay

Return Value

$this

int getNumAttempts()

No description

Return Value

int

int getNumAttemptsRemaining()

No description

Return Value

int

int getTimeToReset()

No description

Return Value

int

$this clearAttempts()

No description

Return Value

$this

$this hit()

Store a hit in the rate limit cache

Return Value

$this

bool canAccess()

No description

Return Value

bool