Spec-Zone.ru › Laravel 5.7

Шлюз

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

Трейты

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

Свойства

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

Методы

Response allow(string|null $message = null)

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

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

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

из HandlesAuthorization
void __construct(Container $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 = [])

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

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

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

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

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

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

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

bool methodAllowsGuests(string $class, string $method)

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

bool callbackAllowsGuests($callback)

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

bool parameterAllowsGuests(ReflectionParameter $parameter)

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

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

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

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

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

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

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

callable resolveAuthCallback(Authenticatable|null $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" для данной политики, если применимо.

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

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

string formatAbilityToMethod(string $ability)

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

Gate forUser(Authenticatable|mixed $user)

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

mixed resolveUser()

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

array abilities()

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

array policies()

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

Подробности

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

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

Параметры

string|null $message

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

Response

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)

Регистрирует обратный вызов для выполнения перед всеми проверками 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

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

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

Параметры

string $ability
array|mixed $arguments

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

Response

Исключения

AuthorizationException

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($callback)

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

Параметры

$callback

Значение возврата

bool

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 void callAfterCallbacks(Authenticatable $user, string $ability, array $arguments, bool $result)

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

Параметры

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

Значение возврата

void

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

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

Spec-Zone.ru

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