Flarum\Extend\ThrottleApi

class ThrottleApi implements ExtenderInterface

Methods

ThrottleApi

set(string $name, string|callable $callback)

Add a new throttler (or override one with the same name).

ThrottleApi

remove(string $name)

Remove a throttler registered with this name.

extend(Container $container, Extension $extension = null)

No description

Add a new throttler (or override one with the same name).

string	$name
string\|callable	$callback	<p>The callable can be a closure or invokable class, and should accept:</p> <ul> <li>$request: The current <code>\Psr\Http\Message\ServerRequestInterface</code> request object. <code>\Flarum\Http\RequestUtil::getActor($request)</code> can be used to get the current user. <code>$request->getAttribute('routeName')</code> can be used to get the current route. Please note that every throttler runs by default on every route. If you only want to throttle certain routes, you'll need to check for that inside your logic.</li> </ul> <p>The callable should return one of:</p> <ul> <li><code>false</code>: This marks the request as NOT to be throttled. It overrides all other throttlers</li> <li><code>true</code>: This marks the request as to be throttled. All other outputs will be ignored.</li> </ul>

Remove a throttler registered with this name.

string

$name

Container	$container
Extension	$extension