1. class
  2. SilverStripe
  3. \
  4. Core
  5. \
  6. Cache
  7. \
  8. RateLimiter

RateLimiter

class RateLimiter

Traits

Injectable
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

from Injectable
static Injectable
singleton(string $class = null)

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

from Injectable
__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

in Injectable at line 26
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'); $list = SiteTree::get();

Parameters

array $args

Return Value

Injectable

in Injectable at line 43
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

at line 40
__construct(string $identifier, int $maxAttempts, int $decay)

RateLimiter constructor.

Parameters

string $identifier
int $maxAttempts
int $decay

at line 50
CacheInterface getCache()

Return Value

CacheInterface

at line 63
$this setCache(CacheInterface $cache)

Parameters

CacheInterface $cache

Return Value

$this

at line 72
string getIdentifier()

Return Value

string

at line 81
$this setIdentifier(string $identifier)

Parameters

string $identifier

Return Value

$this

at line 90
int getMaxAttempts()

Return Value

int

at line 99
$this setMaxAttempts(int $maxAttempts)

Parameters

int $maxAttempts

Return Value

$this

at line 108
int getDecay()

Return Value

int

at line 117
$this setDecay(int $decay)

Parameters

int $decay

Return Value

$this

at line 126
int getNumAttempts()

Return Value

int

at line 134
int getNumAttemptsRemaining()

Return Value

int

at line 142
int getTimeToReset()

Return Value

int

at line 153
$this clearAttempts()

Return Value

$this

at line 164
$this hit()

Store a hit in the rate limit cache

Return Value

$this

at line 181
bool canAccess()

Return Value

bool