1. interface
  2. Illuminate
  3. Contracts
  4. Auth
  5. Access
  6. 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
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.

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

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

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

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

bool
check( string $ability, array|mixed $arguments = array())

Determine if the given ability should be granted.

Gate
forUser( Authenticatable|mixed $user)

Get a guard instance for the given user.

Details

at line line 13
bool has( string $ability)

Determine if a given ability has been defined.

Parameters

string $ability

Return Value

bool

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

Define a new ability.

Parameters

string $ability
callable|string $callback

Return Value

$this

at line line 31
$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 line 39
$this before( callable $callback)

Register a callback to run before all Gate checks.

Parameters

callable $callback

Return Value

$this

at line line 48
bool allows( string $ability, array|mixed $arguments = array())

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

Parameters

string $ability
array|mixed $arguments

Return Value

bool

at line line 57
bool denies( string $ability, array|mixed $arguments = array())

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

Parameters

string $ability
array|mixed $arguments

Return Value

bool

at line line 66
bool check( string $ability, array|mixed $arguments = array())

Determine if the given ability should be granted.

Parameters

string $ability
array|mixed $arguments

Return Value

bool

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

Get a guard instance for the given user.

Parameters

Authenticatable|mixed $user

Return Value

Gate