Spec-Zone.ru › Laravel 5.8

Шлюз

класс Шлюз реализует Шлюз (Просмотреть исходный код)

Трейты

ОбработкаАвторизации

Свойства

protected Контейнер $container Экземпляр контейнера.
protected callable $userResolver Вызываемая функция для получения пользователя.
protected array $abilities Все определенные разрешения.
protected array $policies Все определенные политики.
protected array $beforeCallbacks Все зарегистрированные вызываемые функции до выполнения.
protected array $afterCallbacks Все зарегистрированные вызываемые функции после выполнения.
protected array $stringCallbacks Все определенные разрешения, используя обозначение class@method.
protected callable|null $guessPolicyNamesUsingCallback Вызываемая функция для определения имен политик.

Методы

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

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

из ОбработкаАвторизации
void deny(string $message = 'Это действие не авторизовано.')

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

из ОбработкаАвторизации
void __construct(Контейнер $container, callable $userResolver, array $abilities = [], array $policies = [], array $beforeCallbacks = [], array $afterCallbacks = [], callable $guessPolicyNamesUsingCallback = null)

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

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 = [])

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

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

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

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

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

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

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

bool canBeCalledWithUser(Аутентифицируемый|null $user, Closure|string|array $class, string|null $method = null)

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

bool methodAllowsGuests(string $class, string $method)

Определить, разрешает ли данный метод класса гостям.

bool callbackAllowsGuests(callable $callback)

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

bool parameterAllowsGuests(ReflectionParameter $parameter)

Определить, разрешает ли данный параметр гостям.

bool callAuthCallback(Аутентифицируемый|null $user, string $ability, array $arguments)

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

bool|null callBeforeCallbacks(Аутентифицируемый|null $user, string $ability, array $arguments)

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

bool|null callAfterCallbacks(Аутентифицируемый $user, string $ability, array $arguments, bool $result)

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

callable resolveAuthCallback(Аутентифицируемый|null $user, string $ability, array $arguments)

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

mixed getPolicyFor(object|string $class)

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

array guessPolicyName(string $class)

Угадать имя политики для данного класса.

$this guessPolicyNamesUsing(callable $callback)

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

mixed resolvePolicy(object|string $class)

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

bool|callable resolvePolicyCallback(Аутентифицируемый $user, string $ability, array $arguments, mixed $policy)

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

mixed callPolicyBefore(mixed $policy, Аутентифицируемый $user, string $ability, array $arguments)

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

mixed callPolicyMethod(mixed $policy, string $method, Аутентифицируемый|null $user, array $arguments)

Вызвать соответствующий метод данной политики.

string formatAbilityToMethod(string $ability)

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

Ворота forUser(Аутентифицируемый|mixed $user)

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

mixed resolveUser()

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

array abilities()

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

array policies()

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

Подробности

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

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

Параметры

string|null $message

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

Ответ

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

Выбрасывает исключение несанкционированных действий.

Параметры

string $message

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

void

Исключения

ИсключениеАвторизации

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

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

Параметры

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

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

void

bool has(string $ability)

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

Параметры

string $ability

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

bool

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

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

Параметры

string $ability
callable|string $callback

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

$this

Исключения

ИсключениеНеверныхДанных

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

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

Параметры

string $name
string $class
array $abilities

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

$this

protected Закрытие buildAbilityCallback(string $ability, string $callback)

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

Параметры

string $ability
string $callback

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

Закрытие

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

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

Параметры

string $class
string $policy

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

$this

$this before(callable $callback)

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

Параметры

callable $callback

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

$this

$this after(callable $callback)

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

Параметры

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

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

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

Параметры

iterable|string $abilities
array|mixed $arguments

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

bool

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

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

Параметры

string $ability
array|mixed $arguments

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

Ответ

Исключения

ИсключениеАвторизации

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

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

Параметры

string $ability
array|mixed $arguments

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

mixed

protected bool canBeCalledWithUser(Authenticatable|null $user, Closure|string|array $class, string|null $method = null)

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

Параметры

Authenticatable|null $user
Closure|string|array $class
string|null $method

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

bool

protected bool methodAllowsGuests(string $class, string $method)

Определить, разрешает ли заданный метод класса гостям.

Параметры

string $class
string $method

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

bool

protected bool callbackAllowsGuests(callable $callback)

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

Параметры

callable $callback

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

bool

Исключения

ReflectionException

protected bool parameterAllowsGuests(ReflectionParameter $parameter)

Определить, разрешает ли заданный параметр гостям.

Параметры

ReflectionParameter $parameter

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

bool

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

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

Параметры

Authenticatable|null $user
string $ability
array $arguments

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

bool

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

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

Параметры

Authenticatable|null $user
string $ability
array $arguments

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

bool|null

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

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

Параметры

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

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

bool|null

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

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

Параметры

Authenticatable|null $user
string $ability
array $arguments

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

callable

mixed getPolicyFor(object|string $class)

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

Параметры

object|string $class

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

mixed

protected array guessPolicyName(string $class)

Угадать имя политики для заданного класса.

Параметры

string $class

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

array

$this guessPolicyNamesUsing(callable $callback)

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

Параметры

callable $callback

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

$this

mixed resolvePolicy(object|string $class)

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

Параметры

object|string $class

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

mixed

Исключения

BindingResolutionException

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
END_OF_DOCUMENT_MARKER

protected mixed callPolicyMethod(mixed $policy, string $method, Authenticatable|null $user, array $arguments)

Вызвать соответствующий метод заданной политики.

Параметры

mixed $policy
string $method
Authenticatable|null $user
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.8/Illuminate/Auth/Access/Gate.html

Spec-Zone.ru

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