Spec-Zone.ru › Laravel 5.3

Шлюз

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

Трейты

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

Свойства

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)

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

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

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

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

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

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

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

bool firstArgumentCorrespondsToPolicy(array $arguments)

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

callable resolvePolicyCallback(Authenticatable $user, string $ability, array $arguments)

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

mixed getPolicyFor(object|string $class)

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

mixed resolvePolicy(object|string $class)

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

Gate forUser(Authenticatable|mixed $user)

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

mixed resolveUser()

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

Подробности

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)

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

Parameters

string $ability

Return Value

bool

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

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

Parameters

string $ability
callable|string $callback

Return Value

$this

Exceptions

InvalidArgumentException

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(string $ability, array|mixed $arguments = [])

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

Parameters

string $ability
array|mixed $arguments

Return Value

bool

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

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

Parameters

string $ability
array|mixed $arguments

Return Value

Response

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)

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

Parameters

Authenticatable $user
string $ability
array $arguments

Return Value

bool|null

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

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

Parameters

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

Return Value

void

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

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

Parameters

Authenticatable $user
string $ability
array $arguments

Return Value

callable

protected bool firstArgumentCorrespondsToPolicy(array $arguments)

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

Parameters

array $arguments

Return Value

bool

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

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

Параметры

Authenticatable $user
string $ability
array $arguments

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

callable

mixed getPolicyFor(object|string $class)

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

Параметры

object|string $class

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

mixed

Исключения

InvalidArgumentException

mixed resolvePolicy(object|string $class)

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

Параметры

object|string $class

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

mixed

Gate forUser(Authenticatable|mixed $user)

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

Параметры

Authenticatable|mixed $user

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

Gate

protected mixed resolveUser()

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

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

mixed

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

Spec-Zone.ru

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