1. interface
  2. Illuminate
  3. \
  4. Contracts
  5. \
  6. Auth
  7. \
  8. Access
  9. \
  10. Gate

Gate

interface Gate (View source)

Methods

bool
has(string $ability)

Determine if a given ability has been defined.

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

Define a new ability.

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

Define abilities for a resource.

$this
policy(string $class, string $policy)

Define a policy class for a given class type.

$this
before(callable $callback)

Register a callback to run before all Gate checks.

$this
after(callable $callback)

Register a callback to run after all Gate checks.

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

Determine if all of the given abilities should be granted for the current user.

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

Determine if any of the given abilities should be denied for the current user.

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

Determine if all of the given abilities should be granted for the current user.

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

Determine if any one of the given abilities should be granted for the current user.

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

Determine if the given ability should be granted for the current user.

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

Inspect the user for the given ability.

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

Get the raw result from the authorization callback.

mixed
getPolicyFor(object|string $class)

Get a policy instance for a given class.

Gate
forUser(Authenticatable|mixed $user)

Get a guard instance for the given user.

array
abilities()

Get all of the defined abilities.

Details

at line 13
bool has(string $ability)

Determine if a given ability has been defined.

Parameters

string $ability

Return Value

bool

at line 22
$this define(string $ability, callable|string $callback)

Define a new ability.

Parameters

string $ability
callable|string $callback

Return Value

$this

at line 32
$this resource(string $name, string $class, array|null $abilities = null)

Define abilities for a resource.

Parameters

string $name
string $class
array|null $abilities

Return Value

$this

at line 41
$this policy(string $class, string $policy)

Define a policy class for a given class type.

Parameters

string $class
string $policy

Return Value

$this

at line 49
$this before(callable $callback)

Register a callback to run before all Gate checks.

Parameters

callable $callback

Return Value

$this

at line 57
$this after(callable $callback)

Register a callback to run after all Gate checks.

Parameters

callable $callback

Return Value

$this

at line 66
bool allows(iterable|string $ability, array|mixed $arguments = [])

Determine if all of the given abilities should be granted for the current user.

Parameters

iterable|string $ability
array|mixed $arguments

Return Value

bool

at line 75
bool denies(iterable|string $ability, array|mixed $arguments = [])

Determine if any of the given abilities should be denied for the current user.

Parameters

iterable|string $ability
array|mixed $arguments

Return Value

bool

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

Determine if all of the given abilities should be granted for the current user.

Parameters

iterable|string $abilities
array|mixed $arguments

Return Value

bool

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

Determine if any one of the given abilities should be granted for the current user.

Parameters

iterable|string $abilities
array|mixed $arguments

Return Value

bool

at line 104
Response authorize(string $ability, array|mixed $arguments = [])

Determine if the given ability should be granted for the current user.

Parameters

string $ability
array|mixed $arguments

Return Value

Response

Exceptions

AuthorizationException

at line 113
Response inspect(string $ability, array|mixed $arguments = [])

Inspect the user for the given ability.

Parameters

string $ability
array|mixed $arguments

Return Value

Response

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

Get the raw result from the authorization callback.

Parameters

string $ability
array|mixed $arguments

Return Value

mixed

Exceptions

AuthorizationException

at line 134
mixed getPolicyFor(object|string $class)

Get a policy instance for a given class.

Parameters

object|string $class

Return Value

mixed

Exceptions

InvalidArgumentException

at line 142
Gate forUser(Authenticatable|mixed $user)

Get a guard instance for the given user.

Parameters

Authenticatable|mixed $user

Return Value

Gate

at line 149
array abilities()

Get all of the defined abilities.

Return Value

array