RateLimiter
class RateLimiter extends Facade
Properties
| static protected Container|null | $app | The application instance being facaded. |
from Facade |
| static protected array | $resolvedInstance | The resolved object instances. |
from Facade |
| static protected bool | $cached | Indicates if the resolved instance should be cached. |
from Facade |
Methods
Initiate a mock expectation on the facade.
Initiate a mock expectation on the facade.
Create a fresh mock instance for the given class.
Get the registered name of the component.
Resolve the facade root instance from the container.
Clear a resolved facade instance.
Get the application instance behind the facade.
Handle dynamic, static calls to the object.
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
No description
<int, \Hypervel\RateLimiter\LimitResult> consumeMany(array<int, \Hypervel\RateLimiter\AdmissionPolicy> $policies, \UnitEnum|string|null $limiterName = 'null')
($policy is \Hypervel\RateLimiter\Backoff ? \Hypervel\RateLimiter\BackoffResult : ($policy is \Hypervel\RateLimiter\Cooldown ? \Hypervel\RateLimiter\CooldownResult : \Hypervel\RateLimiter\LimitResult)) inspect(\Hypervel\RateLimiter\AdmissionPolicy|\Hypervel\RateLimiter\Backoff|\Hypervel\RateLimiter\Cooldown $policy, \UnitEnum|string|null $limiterName = 'null')
Details
in
Facade at line 61
static void
resolved(Closure $callback)
Run a Closure when the facade has been resolved.
Boot-only. The callback is registered on the worker-global container and runs for every subsequent resolution of the facade accessor.
in
Facade at line 81
static MockInterface|null
spy()
Convert the facade into a Mockery spy.
Tests only. Swaps the resolved facade instance for the worker lifetime.
in
Facade at line 99
static MockInterface
partialMock()
Initiate a partial mock on the facade.
Tests only. Swaps the resolved facade instance for the worker lifetime.
in
Facade at line 115
static CompositeExpectation|Expectation|HigherOrderMessage
shouldReceive()
Initiate a mock expectation on the facade.
Tests only. Swaps the resolved facade instance for the worker lifetime.
in
Facade at line 131
static CompositeExpectation|Expectation|ExpectsHigherOrderMessage
expects()
Initiate a mock expectation on the facade.
Tests only. Swaps the resolved facade instance for the worker lifetime.
in
Facade at line 145
static protected MockInterface
createFreshMockInstance()
Create a fresh mock instance for the given class.
in
Facade at line 157
static protected MockInterface
createMock()
Create a fresh mock instance for the given class.
in
Facade at line 167
static protected bool
isMock()
Determines whether a mock is set as the instance of the facade.
in
Facade at line 178
static protected string|null
getMockableClass()
Get the mockable class for the bound instance.
in
Facade at line 194
static void
swap(mixed $instance)
Hotswap the underlying instance behind the facade.
Tests only. Replaces the worker-wide resolved facade instance and container binding; runtime use races across coroutines and changes every subsequent facade call.
in
Facade at line 206
static bool
isFake()
Determines whether a "fake" has been set as the facade instance.
in
Facade at line 217
static mixed
getFacadeRoot()
Get the root object behind the facade.
at line 46
static protected string
getFacadeAccessor()
Get the registered name of the component.
in
Facade at line 233
static protected mixed
resolveFacadeInstance(string $name)
Resolve the facade root instance from the container.
in
Facade at line 256
static void
clearResolvedInstance(string|null $name = null)
Clear a resolved facade instance.
Boot or tests only. Clears a worker-wide facade cache entry; concurrent coroutines may still hold the previous resolved instance.
in
Facade at line 267
static void
clearResolvedInstances()
Clear all of the resolved instances.
Boot or tests only. Clears the worker-wide facade cache; concurrent coroutines may still hold previously resolved instances.
in
Facade at line 275
static Collection
defaultAliases()
Get the application default aliases.
in
Facade at line 335
static Container|null
getFacadeApplication()
Get the application instance behind the facade.
in
Facade at line 346
static void
setFacadeApplication(Container|null $app)
Set the application instance.
Boot or tests only. Replaces the worker-wide facade application reference; runtime use races across coroutines and breaks every facade lookup.
in
Facade at line 356
static mixed
__callStatic(string $method, array $args)
Handle dynamic, static calls to the object.
at line 41
static RateLimiter
extend(string $name, Closure $callback)
No description
at line 41
static void
flushMacros()
No description
at line 41
static void
flushState()
No description
at line 41
static RateLimiter
for(UnitEnum|string $name, Closure $callback, UnitEnum|string|null $store = 'null')
No description
at line 41
static RateLimiter
forgetInstance(array|string|null $name = 'null')
No description
at line 41
static string
getDefaultInstance()
No description
at line 41
static array
getInstanceConfig(string $name)
No description
at line 41
static bool
hasMacro(string $name)
No description
at line 41
static mixed
instance(string|null $name = 'null')
No description
at line 41
static Closure|null
limiter(UnitEnum|string $name)
No description
at line 41
static string|null
limiterStore(UnitEnum|string $name)
No description
at line 41
static void
macro(string $name, callable|object $macro)
No description
at line 41
static mixed
macroCall(string $method, array $parameters)
No description
at line 41
static void
mixin(object $mixin, bool $replace = 'true')
No description
at line 41
static void
purge(string|null $name = 'null')
No description
at line 41
static void
resolveKeyScopeUsing(Closure $resolver)
No description
at line 41
static RateLimiter
setApplication(Application $app)
No description
at line 41
static void
setDefaultInstance(string $name)
No description
at line 41
static Limiter
store(UnitEnum|string|null $name = 'null')
No description
at line 41
static mixed
attempt(AdmissionPolicy $policy, Closure $callback, UnitEnum|string|null $limiterName = 'null')
No description
at line 41
static CooldownResult
block(Cooldown $cooldown, int $seconds, UnitEnum|string|null $limiterName = 'null')
No description
at line 41
static bool
clear(Cooldown $policy, UnitEnum|string|null $limiterName = 'null')
No description
at line 41
static LimitResult
consume(AdmissionPolicy $policy, UnitEnum|string|null $limiterName = 'null')
No description
at line 41
static void
array()
<int, \Hypervel\RateLimiter\LimitResult> consumeMany(array<int, \Hypervel\RateLimiter\AdmissionPolicy> $policies, \UnitEnum|string|null $limiterName = 'null')
at line 41
static Store
getStore()
No description
at line 41
void
static()
($policy is \Hypervel\RateLimiter\Backoff ? \Hypervel\RateLimiter\BackoffResult : ($policy is \Hypervel\RateLimiter\Cooldown ? \Hypervel\RateLimiter\CooldownResult : \Hypervel\RateLimiter\LimitResult)) inspect(\Hypervel\RateLimiter\AdmissionPolicy|\Hypervel\RateLimiter\Backoff|\Hypervel\RateLimiter\Cooldown $policy, \UnitEnum|string|null $limiterName = 'null')
at line 41
static BackoffResult
recordFailure(Backoff $backoff, UnitEnum|string|null $limiterName = 'null')
No description