Spec-Zone.ru › Laravel 5.6

Шлюз

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

Трейты

HandlesAuthorization

Свойства

protected Контейнер $container Экземпляр контейнера.
protected вызов $userResolver Вызов для получения пользователя.
protected массив $abilities Все определенные возможности.
protected массив $policies Все определенные политики.
protected массив $beforeCallbacks Все зарегистрированные обратные вызовы до проверки.
protected массив $afterCallbacks Все зарегистрированные обратные вызовы после проверки.

Методы

Ответ allow(string|null $message = null)

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

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

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

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

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

bool has(string $ability)

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

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

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

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

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

Closure buildAbilityCallback(string $ability, 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 = [])

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

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

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

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

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

bool callAuthCallback(Идентифицируемый пользователь $user, string $ability, array $arguments)

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

bool|null callBeforeCallbacks(Идентифицируемый пользователь $user, string $ability, array $arguments)

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

void callAfterCallbacks(Идентифицируемый пользователь $user, string $ability, array $arguments, bool $result)

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

callable resolveAuthCallback(Идентифицируемый пользователь $user, string $ability, array $arguments)

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

mixed getPolicyFor(object|string $class)

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

mixed resolvePolicy(object|string $class)

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

bool|callable resolvePolicyCallback(Идентифицируемый пользователь $user, string $ability, array $arguments, mixed $policy)

Получить обратный вызов для проверки политики.

mixed callPolicyBefore(mixed $policy, Идентифицируемый пользователь $user, string $ability, array $arguments)

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

string formatAbilityToMethod(string $ability)

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

Gate forUser(Идентифицируемый пользователь|mixed $user)

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

mixed resolveUser()

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

массив abilities()

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

массив policies()

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

Подробности

protected Ответ allow(string|null $message = null)

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

Параметры

string|null $message

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

Ответ

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

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

Параметры

string $message

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

void

Исключения

AuthorizationException

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

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

Параметры

Container $container
callable $userResolver
array $abilities
array $policies
array $beforeCallbacks
array $afterCallbacks

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

void

bool has(string $ability)

Определить, был ли определён данный доступ.

Параметры

string $ability

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

bool

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

Определить новый доступ.

Параметры

string $ability
callable|string $callback

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

$this

Исключения

InvalidArgumentException

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

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

Параметры

string $name
string $class
array $abilities

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

$this

protected Closure buildAbilityCallback(string $ability, string $callback)

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

Параметры

string $ability
string $callback

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

Closure

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

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

Параметры

string $class
string $policy

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

$this

$this before(callable $callback)

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

Параметры

callable $callback

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

$this

$this after(callable $callback)

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

Параметры

callable $callback

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

$this

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

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

Параметры

string $ability
array|mixed $arguments

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

bool

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

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

Параметры

string $ability
array|mixed $arguments

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

bool

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

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

Параметры

iterable|string $abilities
array|mixed $arguments

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

bool

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

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

Параметры

iterable|string $abilities
array|mixed $arguments

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

bool

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

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

Параметры

string $ability
array|mixed $arguments

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

Response

Исключения

AuthorizationException

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

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

Параметры

string $ability
array|mixed $arguments

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

mixed

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

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

Параметры

Authenticatable $user
string $ability
array $arguments

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

bool

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

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

Параметры

Authenticatable $user
string $ability
array $arguments

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

bool|null
END_OF_DOCUMENT_MARKER

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.6/Illuminate/Auth/Access/Gate.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API