checkLimitIP() function - Documentation for SproutCMS

function checkLimitIP()

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

File: /sprout/Helpers/RateLimit.php, line 97
Namespace: Sprout\Helpers
Class: RateLimit, Static method

Usage

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

Arguments

string $event
```
Event to check
```

bool|null $success

TRUE to check only successes, FALSE only failures, NULL all events

int $limit
```
Maximum number of events
```
int $time
```
Time to search, in seconds
```

Return value

bool

TRUE if under the limit, FALSE if over the limit