RateLimit class - Documentation for SproutCMS

Info Page:

Page options:

class RateLimit

Rate-limiting system, to prefent people form doing hacky stuff

Name	Visibility	Description
checkLimitIP	public (static)	Check that a given event has only been hit by the request ip address an allowable number of times
getHitCount	public (static)	Return the number of hits matching given conditions for a given time period
logHit	protected (static)	Log a hit against the rate-limit system
logHitFailure	public (static)	Log a failure hit against the rate-limit system (e.g. password incorrect)
logHitSuccess	public (static)	Log a successful hit against the rate-limit system (e.g. user was logged in)

bool RateLimit::checkLimitIP ( string $event , bool|null $success , int $limit , int $time );

Check that a given event has only been hit by the request ip address an allowable number of times

int RateLimit::getHitCount ( array $conditions , int $time );

Return the number of hits matching given conditions for a given time period

void RateLimit::logHit ( string $event , bool $success , string $username );

Log a hit against the rate-limit system

void RateLimit::logHitFailure ( string $event [, string $username ] );

Log a failure hit against the rate-limit system (e.g. password incorrect)

void RateLimit::logHitSuccess ( string $event [, string $username ] );

Log a successful hit against the rate-limit system (e.g. user was logged in)