class Gate 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

static void
resolved(Closure $callback)

Run a Closure when the facade has been resolved.

from  Facade
static MockInterface|null
spy()

Convert the facade into a Mockery spy.

from  Facade
static MockInterface
partialMock()

Initiate a partial mock on the facade.

from  Facade
static CompositeExpectation|Expectation|HigherOrderMessage
shouldReceive()

Initiate a mock expectation on the facade.

from  Facade
static CompositeExpectation|Expectation|ExpectsHigherOrderMessage
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|null $name = null)

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 Container|null
getFacadeApplication()

Get the application instance behind the facade.

from  Facade
static void
setFacadeApplication(Container|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 array
abilities()

No description

static Gate
after(callable $callback)

No description

static Response
allowIf(mixed $condition, string|null $message = 'null', string|int|null $code = 'null')

No description

static bool
allows(UnitEnum|array|string $ability, mixed $arguments = '[]')

No description

static bool
any(UnitEnum|array|string $abilities, mixed $arguments = '[]')

No description

static Response
authorize(UnitEnum|string $ability, mixed $arguments = '[]')

No description

static Gate
before(callable $callback)

No description

static bool
check(UnitEnum|array|string $abilities, mixed $arguments = '[]')

No description

static Gate
defaultDenialResponse(Response $response)

No description

static Gate
define(UnitEnum|string $ability, callable|array|string $callback)

No description

static bool
denies(UnitEnum|array|string $ability, mixed $arguments = '[]')

No description

static Response
denyAsNotFound(string|null $message = 'null', string|int|null $code = 'null')

No description

static Response
denyIf(mixed $condition, string|null $message = 'null', string|int|null $code = 'null')

No description

static Response
denyWithStatus(int $status, string|null $message = 'null', string|int|null $code = 'null')

No description

static void
flushState()

No description

static Gate
forUser(mixed $user)

No description

static mixed
getPolicyFor(object|string $class)

No description

static Gate
guessPolicyNamesUsing(callable $callback)

No description

static bool
has(UnitEnum|array|string $ability)

No description

static Response
inspect(UnitEnum|string $ability, mixed $arguments = '[]')

No description

static bool
none(UnitEnum|array|string $abilities, mixed $arguments = '[]')

No description

static array
policies()

No description

static Gate
policy(string $class, string $policy)

No description

static mixed
raw(string $ability, mixed $arguments = '[]')

No description

static mixed
resolvePolicy(object|string $class)

No description

static Gate
resource(string $name, string $class, array|null $abilities = 'null')

No description

static Builder
scope(UnitEnum|string $ability, Builder $query)

No description

static Builder
select(UnitEnum|string $ability, Model $query)

No description

static Gate
setContainer(Container $container)

No description

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.

Parameters

Closure $callback

Return Value

void

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.

Return Value

MockInterface|null

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.

Return Value

MockInterface

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.

Return Value

CompositeExpectation|Expectation|HigherOrderMessage

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.

Return Value

CompositeExpectation|Expectation|ExpectsHigherOrderMessage

in Facade at line 145
static protected MockInterface createFreshMockInstance()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 157
static protected MockInterface createMock()

Create a fresh mock instance for the given class.

Return Value

MockInterface

in Facade at line 167
static protected bool isMock()

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

Return Value

bool

in Facade at line 178
static protected string|null getMockableClass()

Get the mockable class for the bound instance.

Return Value

string|null

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.

Parameters

mixed $instance

Return Value

void

in Facade at line 206
static bool isFake()

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

Return Value

bool

in Facade at line 217
static mixed getFacadeRoot()

Get the root object behind the facade.

Return Value

mixed

at line 47
static protected string getFacadeAccessor()

Get the registered name of the component.

Return Value

string

in Facade at line 233
static protected mixed resolveFacadeInstance(string $name)

Resolve the facade root instance from the container.

Parameters

string $name

Return Value

mixed

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.

Parameters

string|null $name

Return Value

void

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.

Return Value

void

in Facade at line 275
static Collection defaultAliases()

Get the application default aliases.

Return Value

Collection

in Facade at line 335
static Container|null getFacadeApplication()

Get the application instance behind the facade.

Return Value

Container|null

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.

Parameters

Container|null $app

Return Value

void

in Facade at line 356
static mixed __callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

Parameters

string $method
array $args

Return Value

mixed

Exceptions

RuntimeException

at line 42
static array abilities()

No description

Return Value

array

at line 42
static Gate after(callable $callback)

No description

Parameters

callable $callback

Return Value

Gate

at line 42
static Response allowIf(mixed $condition, string|null $message = 'null', string|int|null $code = 'null')

No description

Parameters

mixed $condition
string|null $message
string|int|null $code

Return Value

Response

at line 42
static bool allows(UnitEnum|array|string $ability, mixed $arguments = '[]')

No description

Parameters

UnitEnum|array|string $ability
mixed $arguments

Return Value

bool

at line 42
static bool any(UnitEnum|array|string $abilities, mixed $arguments = '[]')

No description

Parameters

UnitEnum|array|string $abilities
mixed $arguments

Return Value

bool

at line 42
static Response authorize(UnitEnum|string $ability, mixed $arguments = '[]')

No description

Parameters

UnitEnum|string $ability
mixed $arguments

Return Value

Response

at line 42
static Gate before(callable $callback)

No description

Parameters

callable $callback

Return Value

Gate

at line 42
static bool check(UnitEnum|array|string $abilities, mixed $arguments = '[]')

No description

Parameters

UnitEnum|array|string $abilities
mixed $arguments

Return Value

bool

at line 42
static Gate defaultDenialResponse(Response $response)

No description

Parameters

Response $response

Return Value

Gate

at line 42
static Gate define(UnitEnum|string $ability, callable|array|string $callback)

No description

Parameters

UnitEnum|string $ability
callable|array|string $callback

Return Value

Gate

at line 42
static bool denies(UnitEnum|array|string $ability, mixed $arguments = '[]')

No description

Parameters

UnitEnum|array|string $ability
mixed $arguments

Return Value

bool

at line 42
static Response denyAsNotFound(string|null $message = 'null', string|int|null $code = 'null')

No description

Parameters

string|null $message
string|int|null $code

Return Value

Response

at line 42
static Response denyIf(mixed $condition, string|null $message = 'null', string|int|null $code = 'null')

No description

Parameters

mixed $condition
string|null $message
string|int|null $code

Return Value

Response

at line 42
static Response denyWithStatus(int $status, string|null $message = 'null', string|int|null $code = 'null')

No description

Parameters

int $status
string|null $message
string|int|null $code

Return Value

Response

at line 42
static void flushState()

No description

Return Value

void

at line 42
static Gate forUser(mixed $user)

No description

Parameters

mixed $user

Return Value

Gate

at line 42
static mixed getPolicyFor(object|string $class)

No description

Parameters

object|string $class

Return Value

mixed

at line 42
static Gate guessPolicyNamesUsing(callable $callback)

No description

Parameters

callable $callback

Return Value

Gate

at line 42
static bool has(UnitEnum|array|string $ability)

No description

Parameters

UnitEnum|array|string $ability

Return Value

bool

at line 42
static Response inspect(UnitEnum|string $ability, mixed $arguments = '[]')

No description

Parameters

UnitEnum|string $ability
mixed $arguments

Return Value

Response

at line 42
static bool none(UnitEnum|array|string $abilities, mixed $arguments = '[]')

No description

Parameters

UnitEnum|array|string $abilities
mixed $arguments

Return Value

bool

at line 42
static array policies()

No description

Return Value

array

at line 42
static Gate policy(string $class, string $policy)

No description

Parameters

string $class
string $policy

Return Value

Gate

at line 42
static mixed raw(string $ability, mixed $arguments = '[]')

No description

Parameters

string $ability
mixed $arguments

Return Value

mixed

at line 42
static mixed resolvePolicy(object|string $class)

No description

Parameters

object|string $class

Return Value

mixed

at line 42
static Gate resource(string $name, string $class, array|null $abilities = 'null')

No description

Parameters

string $name
string $class
array|null $abilities

Return Value

Gate

at line 42
static Builder scope(UnitEnum|string $ability, Builder $query)

No description

Parameters

UnitEnum|string $ability
Builder $query

Return Value

Builder

at line 42
static Builder select(UnitEnum|string $ability, Model $query)

No description

Parameters

UnitEnum|string $ability
Model $query

Return Value

Builder

at line 42
static Gate setContainer(Container $container)

No description

Parameters

Container $container

Return Value

Gate