Gate

класс Gate реализует Gate (View source)

Черты

Свойства

protected Container	$container	Экземпляр контейнера.
protected callable	$userResolver	Вызываемый объект для разрешения пользователя.
protected array	$abilities	Все определенные возможности.
protected array	$policies	Все определенные политики.
protected array	$beforeCallbacks	Все зарегистрированные обратные вызовы before.
protected array	$afterCallbacks	Все зарегистрированные обратные вызовы after.

Методы

Response

allow(string|null $message = null)

Создать новый ответ доступа.

из HandlesAuthorization

void

deny(string $message = 'This action is unauthorized.')

Выбрасывает исключение несанкционированного доступа.

из HandlesAuthorization

void

__construct(Container $container, callable $userResolver, array $abilities = [], array $policies = [], array $beforeCallbacks = [], array $afterCallbacks = [])

Создать новый экземпляр gate.

bool

has(string $ability)

Определить, была ли определена данная возможность.

$this

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

Определить новую возможность.

$this

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

Определить возможности для ресурса.

Closure

buildAbilityCallback(string $callback)

Создать обратный вызов возможности для строки обратного вызова.

$this

policy(string $class, string $policy)

Определить класс политики для данного типа класса.

$this

before(callable $callback)

Зарегистрировать обратный вызов для выполнения перед всеми проверками Gate.

$this

after(callable $callback)

Зарегистрировать обратный вызов для выполнения после всех проверок Gate.

bool

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

Определить, следует ли предоставить данную возможность для текущего пользователя.

bool

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

Определить, следует ли отказать в данной возможности для текущего пользователя.

bool

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

Определить, следует ли предоставить все заданные возможности для текущего пользователя.

bool

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

Определить, следует ли предоставить хотя бы одну из заданных возможностей для текущего пользователя.

Response

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

Определить, следует ли предоставить данную возможность для текущего пользователя.

mixed

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

Получить необработанный результат из обратного вызова авторизации.

bool

callAuthCallback(Authenticatable $user, string $ability, array $arguments)

Разрешить и вызвать соответствующий обратный вызов авторизации.

bool|null

callBeforeCallbacks(Authenticatable $user, string $ability, array $arguments)

Вызвать все обратные вызовы before и вернуть результат, если он есть.

void

callAfterCallbacks(Authenticatable $user, string $ability, array $arguments, bool $result)

Вызвать все обратные вызовы after с результатом проверки.

callable

resolveAuthCallback(Authenticatable $user, string $ability, array $arguments)

Разрешить вызываемый объект для данной возможности и аргументов.

mixed

getPolicyFor(object|string $class)

Получить экземпляр политики для данного класса.

mixed

resolvePolicy(object|string $class)

Построить экземпляр класса политики данного типа.

bool|callable

resolvePolicyCallback(Authenticatable $user, string $ability, array $arguments, mixed $policy)

Разрешить обратный вызов для проверки политики.

mixed

callPolicyBefore(mixed $policy, Authenticatable $user, string $ability, array $arguments)

Вызвать метод "before" в данной политике, если применимо.

string

formatAbilityToMethod(string $ability)

Сформатировать возможность политики в имя метода.

Gate

forUser(Authenticatable|mixed $user)

Получить экземпляр gate для данного пользователя.

mixed

resolveUser()

Разрешить пользователя из решателя пользователей.

array

abilities()

Получить все определенные возможности.

array

policies()

Получить все определенные политики.

Подробности

protected Response allow(string|null $message = null)

Создать новый ответ доступа.

Параметры

string|null

$message

Возвращаемое значение

Response

END_OF_DOCUMENT_MARKER

protected void deny(string $message = 'Это действие не разрешено.')

Выбрасывает исключение несанкционированного доступа.

Parameters

string

$message

Return Value

void

Exceptions

AuthorizationException

void __construct(Контейнер $container, callable $userResolver, array $abilities = [], array $policies = [], array $beforeCallbacks = [], array $afterCallbacks = [])

Создает новый экземпляр шлюза.

Parameters

Контейнер	$container
callable	$userResolver
array	$abilities
array	$policies
array	$beforeCallbacks
array	$afterCallbacks

Return Value

void

bool has(string $ability)

Определяет, определено ли данное разрешение.

Parameters

string

$ability

Return Value

bool

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

Определяет новое разрешение.

Parameters

string	$ability
callable\|string	$callback

Return Value

$this

Exceptions

InvalidArgumentException

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

Определяет разрешения для ресурса.

Parameters

string	$name
string	$class
array	$abilities

Return Value

$this

protected Closure buildAbilityCallback(string $callback)

Создает обратный вызов разрешения для строки обратного вызова.

Parameters

string

$callback

Return Value

Closure

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

Определяет класс политики для заданного типа класса.

Parameters

string	$class
string	$policy

Return Value

$this

$this before(callable $callback)

Регистрирует обратный вызов для выполнения перед всеми проверками Gate.

Parameters

callable

$callback

Return Value

$this

$this after(callable $callback)

Регистрирует обратный вызов для выполнения после всех проверок Gate.

Parameters

callable

$callback

Return Value

$this

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

Определяет, должно ли данное разрешение быть предоставлено текущему пользователю.

Parameters

string	$ability
array\|mixed	$arguments

Return Value

bool

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

Определяет, должно ли данное разрешение быть отказано текущему пользователю.

Parameters

string	$ability
array\|mixed	$arguments

Return Value

bool

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

Определяет, должны ли все заданные разрешения быть предоставлены текущему пользователю.

Parameters

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

Return Value

bool

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

Определяет, должно ли быть предоставлено любое из заданных разрешений текущему пользователю.

Parameters

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

Return Value

bool

Ответ authorize(string $ability, array|mixed $arguments = [])

Определяет, должно ли данное разрешение быть предоставлено текущему пользователю.

Parameters

string	$ability
array\|mixed	$arguments

Return Value

Ответ

Exceptions

AuthorizationException

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

Получить исходный результат из обратного вызова авторизации.

Parameters

string	$ability
array\|mixed	$arguments

Return Value

mixed

protected bool callAuthCallback(Authenticatable $user, string $ability, array $arguments)

Разрешить и вызвать соответствующий обратный вызов авторизации.

Parameters

Authenticatable	$user
string	$ability
array	$arguments

Return Value

bool

protected bool|null callBeforeCallbacks(Authenticatable $user, string $ability, array $arguments)

Вызвать все обратные вызовы перед и вернуть, если результат задан.

Parameters

Authenticatable	$user
string	$ability
array	$arguments

Return Value

bool|null

protected void callAfterCallbacks(Authenticatable $user, string $ability, array $arguments, bool $result)

Вызвать все послеобработки с результатом проверки.

Параметры

Authenticatable	$user
string	$ability
array	$arguments
bool	$result

Возвращаемое значение

void

protected callable resolveAuthCallback(Authenticatable $user, string $ability, array $arguments)

Разрешить вызов для заданного разрешения и аргументов.

Параметры

Authenticatable	$user
string	$ability
array	$arguments

Возвращаемое значение

callable

mixed getPolicyFor(object|string $class)

Получить экземпляр политики для данного класса.

Параметры

object|string

$class

Возвращаемое значение

mixed

mixed resolvePolicy(object|string $class)

Создать экземпляр класса политики указанного типа.

Параметры

object|string

$class

Возвращаемое значение

mixed

protected bool|callable resolvePolicyCallback(Authenticatable $user, string $ability, array $arguments, mixed $policy)

Разрешить обратный вызов для проверки политики.

Параметры

Authenticatable	$user
string	$ability
array	$arguments
mixed	$policy

Возвращаемое значение

bool|callable

protected mixed callPolicyBefore(mixed $policy, Authenticatable $user, string $ability, array $arguments)

Вызвать метод «before» для данной политики, если применимо.

Параметры

mixed	$policy
Authenticatable	$user
string	$ability
array	$arguments

Возвращаемое значение

mixed

protected string formatAbilityToMethod(string $ability)

Отформатировать разрешение политики в имя метода.

Параметры

string

$ability

Возвращаемое значение

string

Gate forUser(Authenticatable|mixed $user)

Получить экземпляр ворот для данного пользователя.

Параметры

Authenticatable|mixed

$user

Возвращаемое значение

Gate

protected mixed resolveUser()

Разрешить пользователя из разрешателя пользователя.

Возвращаемое значение

mixed

array abilities()

Получить все определенные разрешения.

Возвращаемое значение

array

array policies()

Получить все определенные политики.

Возвращаемое значение

array

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.5/Illuminate/Auth/Access/Gate.html