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.

from  Facade
static MockInterface
spy()

Convert the facade into a Mockery spy.

from  Facade
static MockInterface
partialMock()

Initiate a partial mock on the facade.

from  Facade
static Expectation
shouldReceive()

Initiate a mock expectation on the facade.

from  Facade
static Expectation
expects()

Initiate a mock expectation on the facade.

from  Facade
static MockInterface
createFreshMockInstance()

Create a fresh mock instance for the given class.

from  Facade
static MockInterface
createMock()

Create a fresh mock instance for the given class.

from  Facade
static bool
isMock()

Determines whether a mock is set as the instance of the facade.

from  Facade
static string|null
getMockableClass()

Get the mockable class for the bound instance.

from  Facade
static void
swap(mixed $instance)

Hotswap the underlying instance behind the facade.

from  Facade
static bool
isFake()

Determines whether a "fake" has been set as the facade instance.

from  Facade
static mixed
getFacadeRoot()

Get the root object behind the facade.

from  Facade
static string
getFacadeAccessor()

Get the registered name of the component.

static mixed
resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

from  Facade
static void
clearResolvedInstance(string $name)

Clear a resolved facade instance.

from  Facade
static void
clearResolvedInstances()

Clear all of the resolved instances.

from  Facade
static Collection
defaultAliases()

Get the application default aliases.

from  Facade
static Application|null
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(Application|null $app)

Set the application instance.

from  Facade
static mixed
__callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

from  Facade
static RateLimiter
for(string $name, Closure $callback)

No description

static Closure|null
limiter(string $name)

No description

static mixed
attempt(string $key, int $maxAttempts, Closure $callback, int $decaySeconds = 60)

No description

static bool
tooManyAttempts(string $key, int $maxAttempts)

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 mixed
attempts(string $key)

No description

static mixed
resetAttempts(string $key)

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

static int
availableIn(string $key)

No description

static string
cleanRateLimiterKey(string $key)

No description

Details

static void resolved(Closure $callback)

Run a Closure when the facade has been resolved.

Parameters

Closure $callback

Return Value

void

static MockInterface spy()

Convert the facade into a Mockery spy.

Return Value

MockInterface

static MockInterface partialMock()

Initiate a partial mock on the facade.

Return Value

MockInterface

static Expectation shouldReceive()

Initiate a mock expectation on the facade.

Return Value

Expectation

static Expectation expects()

Initiate a mock expectation on the facade.

Return Value

Expectation

static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

static protected bool isMock()

Determines whether a mock is set as the instance of the facade.

Return Value

bool

static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

static void swap(mixed $instance)

Hotswap the underlying instance behind the facade.

Parameters

mixed $instance

Return Value

void

static protected bool isFake()

Determines whether a "fake" has been set as the facade instance.

Return Value

bool

static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

static void clearResolvedInstance(string $name)

Clear a resolved facade instance.

Parameters

string $name

Return Value

void

static void clearResolvedInstances()

Clear all of the resolved instances.

Return Value

void

static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

static Application|null getFacadeApplication()

Get the application instance behind the facade.

Return Value

Application|null

static void setFacadeApplication(Application|null $app)

Set the application instance.

Parameters

Application|null $app

Return Value

void

static mixed __callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

Exceptions

RuntimeException

static RateLimiter for(string $name, Closure $callback)

No description

Parameters

string $name
Closure $callback

Return Value

RateLimiter

static Closure|null limiter(string $name)

No description

Parameters

string $name

Return Value

Closure|null

static mixed attempt(string $key, int $maxAttempts, Closure $callback, int $decaySeconds = 60)

No description

Parameters

string $key
int $maxAttempts
Closure $callback
int $decaySeconds

Return Value

mixed

static bool tooManyAttempts(string $key, int $maxAttempts)

No description

Parameters

string $key
int $maxAttempts

Return Value

bool

static int hit(string $key, int $decaySeconds = 60)

No description

Parameters

string $key
int $decaySeconds

Return Value

int

static int increment(string $key, int $decaySeconds = 60, int $amount = 1)

No description

Parameters

string $key
int $decaySeconds
int $amount

Return Value

int

static mixed attempts(string $key)

No description

Parameters

string $key

Return Value

mixed

static mixed resetAttempts(string $key)

No description

Parameters

string $key

Return Value

mixed

static int remaining(string $key, int $maxAttempts)

No description

Parameters

string $key
int $maxAttempts

Return Value

int

static int retriesLeft(string $key, int $maxAttempts)

No description

Parameters

string $key
int $maxAttempts

Return Value

int

static void clear(string $key)

No description

Parameters

string $key

Return Value

void

static int availableIn(string $key)

No description

Parameters

string $key

Return Value

int

static string cleanRateLimiterKey(string $key)

No description

Parameters

string $key

Return Value

string