class
RateLimiter extends Facade (View source)
Properties
static protected Application|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
static void
resolved(
Closure $callback)
Run a Closure when the facade has been resolved.
spy()
Convert the facade into a Mockery spy.
expects()
Initiate a mock expectation on the facade.
createMock()
Create a fresh mock instance for the given class.
static bool
isMock()
Determines whether a mock is set as the instance of the facade.
static void
swap(mixed $instance)
Hotswap the underlying instance behind the facade.
static bool
isFake()
Determines whether a "fake" has been set as the facade instance.
static mixed
__callStatic(string $method, array $args)
Handle dynamic, static calls to the object.
for(
UnitEnum|string $name,
Closure $callback)
No description
static Closure|null
limiter(
UnitEnum|string $name)
No description
static mixed
attempt(string $key, int $maxAttempts,
Closure $callback, int $decaySeconds = 60)
No description
static int
hit(string $key, int $decaySeconds = 60)
No description
static int
increment(string $key, int $decaySeconds = 60, int $amount = 1)
No description
static int
decrement(string $key, int $decaySeconds = 60, int $amount = 1)
No description
static int
remaining(string $key, int $maxAttempts)
No description
static int
retriesLeft(string $key, int $maxAttempts)
No description
static void
clear(string $key)
No description
Details
Run a Closure when the facade has been resolved.
Convert the facade into a Mockery spy.
static MockInterface
partialMock()
Initiate a partial mock on the facade.
static Expectation
shouldReceive()
Initiate a mock expectation on the facade.
Initiate a mock expectation on the facade.
static protected MockInterface
createFreshMockInstance()
Create a fresh mock instance for the given class.
static protected MockInterface
createMock()
Create a fresh mock instance for the given class.
static protected bool
isMock()
Determines whether a mock is set as the instance of the facade.
static protected string|null
getMockableClass()
Get the mockable class for the bound instance.
static void
swap(mixed $instance)
Hotswap the underlying instance behind the facade.
Determines whether a "fake" has been set as the facade instance.
Get the root object behind the facade.
static protected string
getFacadeAccessor()
Get the registered name of the component.
static protected mixed
resolveFacadeInstance(string $name)
Resolve the facade root instance from the container.
static void
clearResolvedInstance(string $name)
Clear a resolved facade instance.
static void
clearResolvedInstances()
Clear all of the resolved instances.
Get the application default aliases.
Get the application instance behind the facade.
Set the application instance.
static mixed
__callStatic(string $method, array $args)
Handle dynamic, static calls to the object.
static Closure|null
limiter(UnitEnum|string $name)
static mixed
attempt(string $key, int $maxAttempts, Closure $callback, int $decaySeconds = 60)
static bool
tooManyAttempts(string $key, int $maxAttempts)
static int
hit(string $key, int $decaySeconds = 60)
static int
increment(string $key, int $decaySeconds = 60, int $amount = 1)
static int
decrement(string $key, int $decaySeconds = 60, int $amount = 1)
static mixed
attempts(string $key)
static mixed
resetAttempts(string $key)
static int
remaining(string $key, int $maxAttempts)
static int
retriesLeft(string $key, int $maxAttempts)
static void
clear(string $key)
static int
availableIn(string $key)
static string
cleanRateLimiterKey(string $key)