[8.x] Adds attempt method to Rate Limiter

[DarkGhostHunter]

What?

You can use the attempt() from the Rate Limiter to execute a callback if available.

use Illuminate\Support\Facades\RateLimiter;

RateLimiter::attempt('something', 5, function () {
    // ...
});

Fourth argument, decaySeconds, is default to 60.

How?

It just simply wraps the tooManyAttempts() and hit() in one call. Syntactic sugar for this:

use Illuminate\Support\Facades\RateLimiter;

if (RateLimiter::tooManyAttempts('something', 5)) {
    return false
}

// Do something...

RateLimiter::hit('something', 60);

return true;

If the shortcut fails, false is returned. Otherwise, it returns result of the callback, or true if the result is null. THis allows the developer to programmatically proceed if the call wasn't executed.

use Illuminate\Support\Facades\RateLimiter;

$executed = RateLimiter::attempt('something', 5, fn() => 'foo', 60 * 60);

if ($executed) {
    return "It returned $executed";
}

Why?

• Simplifies effective Rate Limiter usage into one method easy to understand. (Should be documented too!)

[DarkGhostHunter]

Success!