Gate

class Gate extends Facade (View source)

Properties

static protected Application	$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

getFacadeApplication()

Get the application instance behind the facade.

from Facade

static void

setFacadeApplication(Application $app)

Set the application instance.

from Facade

static mixed

__callStatic(string $method, array $args)

Handle dynamic, static calls to the object.

from Facade

static bool

has(string|array $ability)

No description

static Response

allowIf(Closure|bool $condition, string|null $message = null, string|null $code = null)

No description

static Response

denyIf(Closure|bool $condition, string|null $message = null, string|null $code = null)

No description

static Gate

define(string $ability, callable|array|string $callback)

No description

static Gate

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

No description

static Gate

policy(string $class, string $policy)

No description

static Gate

before(callable $callback)

No description

static Gate

after(callable $callback)

No description

static bool

allows(string $ability, array|mixed $arguments = [])

No description

static bool

denies(string $ability, array|mixed $arguments = [])

No description

static bool

check(iterable|string $abilities, array|mixed $arguments = [])

No description

static bool

any(iterable|string $abilities, array|mixed $arguments = [])

No description

static bool

none(iterable|string $abilities, array|mixed $arguments = [])

No description

static Response

authorize(string $ability, array|mixed $arguments = [])

No description

static Response

inspect(string $ability, array|mixed $arguments = [])

No description

static mixed

raw(string $ability, array|mixed $arguments = [])

No description

static mixed

getPolicyFor(object|string $class)

No description

static Gate

guessPolicyNamesUsing(callable $callback)

No description

static mixed

resolvePolicy(object|string $class)

No description

static Gate

forUser(Authenticatable|mixed $user)

No description

static array

abilities()

No description

static array

policies()

No description

static Gate

setContainer(Container $container)

No description

static Response

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

No description

static Response

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

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

Get the application instance behind the facade.

Return Value

Application

static void setFacadeApplication(Application $app)

Set the application instance.

Parameters

Application

$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 bool has(string|array $ability)

No description

Parameters

string|array

$ability

Return Value

bool

static Response allowIf(Closure|bool $condition, string|null $message = null, string|null $code = null)

No description

Parameters

Closure\|bool	$condition
string\|null	$message
string\|null	$code

Return Value

Response

static Response denyIf(Closure|bool $condition, string|null $message = null, string|null $code = null)

No description

Parameters

Closure\|bool	$condition
string\|null	$message
string\|null	$code

Return Value

Response

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

No description

Parameters

string	$ability
callable\|array\|string	$callback

Return Value

Gate

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

No description

Parameters

string	$name
string	$class
array\|null	$abilities

Return Value

Gate

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

No description

Parameters

string	$class
string	$policy

Return Value

Gate

static Gate before(callable $callback)

No description

Parameters

callable

$callback

Return Value

Gate

static Gate after(callable $callback)

No description

Parameters

callable

$callback

Return Value

Gate

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

No description

Parameters

string	$ability
array\|mixed	$arguments

Return Value

bool

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

No description

Parameters

string	$ability
array\|mixed	$arguments

Return Value

bool

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

No description

Parameters

iterable\|string	$abilities
array\|mixed	$arguments

Return Value

bool

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

No description

Parameters

iterable\|string	$abilities
array\|mixed	$arguments

Return Value

bool

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

No description

Parameters

iterable\|string	$abilities
array\|mixed	$arguments

Return Value

bool

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

No description

Parameters

string	$ability
array\|mixed	$arguments

Return Value

Response

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

No description

Parameters

string	$ability
array\|mixed	$arguments

Return Value

Response

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

No description

Parameters

string	$ability
array\|mixed	$arguments

Return Value

mixed

static mixed getPolicyFor(object|string $class)

No description

Parameters

object|string

$class

Return Value

mixed

static Gate guessPolicyNamesUsing(callable $callback)

No description

Parameters

callable

$callback

Return Value

Gate

static mixed resolvePolicy(object|string $class)

No description

Parameters

object|string

$class

Return Value

mixed

static Gate forUser(Authenticatable|mixed $user)

No description

Parameters

Authenticatable|mixed

$user

Return Value

Gate

static array abilities()

No description

Return Value

array

static array policies()

No description

Return Value

array

static Gate setContainer(Container $container)

No description

Parameters

Container

$container

Return Value

Gate

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

No description

Parameters

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

Return Value

Response

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

No description

Parameters

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

Return Value

Response

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/10.x/Illuminate/Support/Facades/Gate.html