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 $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(string $ability, array|mixed $arguments = []) Determine if the given ability should be granted for the current user. | |
| bool | denies(string $ability, array|mixed $arguments = []) Determine if the given ability 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
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 $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(string $ability, array|mixed $arguments = [])
Determine if the given ability should be granted for the current user.
bool denies(string $ability, array|mixed $arguments = [])
Determine if the given ability 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.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/6.x/Illuminate/Contracts/Auth/Access/Gate.html