Spec-Zone.ru › Laravel 6

Шлюз

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

Трейты

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

Свойства

protected Контейнер $container

Экземпляр контейнера.

protected callable $userResolver

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

protected array $abilities

Все определённые возможности.

protected array $policies

Все определённые политики.

protected array $beforeCallbacks

Все зарегистрированные обратные вызовы до.

protected array $afterCallbacks

Все зарегистрированные обратные вызовы после.

protected array $stringCallbacks

Все определённые возможности, используя обозначение класса@метод.

protected callable|null $guessPolicyNamesUsingCallback

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

Методы

Response allow(string|null $message = null, mixed $code = null)

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

из HandlesAuthorization
Response deny(string|null $message = null, mixed|null $code = null)

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

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

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

$this after(callable $callback)

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

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

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

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

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

Response inspect(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(callable $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 и вернуть, если результат предоставлен.

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

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

callable resolveAuthCallback(Authenticatable|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(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, mixed $code = null)

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

Параметры

string|null $message
mixed $code

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

Response

protected Response deny(string|null $message = null, mixed|null $code = null)

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

Параметры

string|null $message
mixed|null $code

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

Response

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

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

Параметры

Container $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

Исключения

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

bool none(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
END_OF_DOCUMENT_MARKER

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

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

Parameters

string $ability
array|mixed $arguments

Return Value

Response

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

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

Parameters

string $ability
array|mixed $arguments

Return Value

mixed

Exceptions

AuthorizationException

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

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

Parameters

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

Return Value

bool

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

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

Parameters

string $class
string $method

Return Value

bool

protected bool callbackAllowsGuests(callable $callback)

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

Parameters

callable $callback

Return Value

bool

Exceptions

ReflectionException

protected bool parameterAllowsGuests(ReflectionParameter $parameter)

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

Parameters

ReflectionParameter $parameter

Return Value

bool

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

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

Parameters

Authenticatable|null $user
string $ability
array $arguments

Return Value

bool

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

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

Parameters

Authenticatable|null $user
string $ability
array $arguments

Return Value

bool|null

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

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

Parameters

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

Return Value

bool|null

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

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

Parameters

Authenticatable|null $user
string $ability
array $arguments

Return Value

callable

mixed getPolicyFor(object|string $class)

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

Parameters

object|string $class

Return Value

mixed

protected array guessPolicyName(string $class)

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

Parameters

string $class

Return Value

array

$this guessPolicyNamesUsing(callable $callback)

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

Parameters

callable $callback

Return Value

$this

mixed resolvePolicy(object|string $class)

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

Parameters

object|string $class

Return Value

mixed

Exceptions

BindingResolutionException

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

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

Parameters

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

Return Value

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

Spec-Zone.ru

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