Spec-Zone.ru › Laravel 8

RequestGuard

класс RequestGuard реализует Guard (View source)

Черты

GuardHelpers

Эти методы обычно одинаковы для всех стражей.

Macroable

Свойства

protected Authenticatable $user

Текущий аутентифицированный пользователь.

из GuardHelpers
protected UserProvider $provider

Реализация поставщика пользователей.

из GuardHelpers
static protected array $macros

Зарегистрированные строковые макросы.

из Macroable
protected callable $callback

Обратный вызов стражи.

protected Request $request

Экземпляр запроса.

Методы

Authenticatable authenticate()

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

из GuardHelpers
bool hasUser()

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

из GuardHelpers
bool check()

Определить, аутентифицирован ли текущий пользователь.

из GuardHelpers
bool guest()

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

из GuardHelpers
int|string|null id()

Получить ID для текущего аутентифицированного пользователя.

из GuardHelpers
$this setUser(Authenticatable $user)

Установить текущего пользователя.

из GuardHelpers
UserProvider getProvider()

Получить поставщика пользователей, используемый стражей.

из GuardHelpers
void setProvider(UserProvider $provider)

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

из GuardHelpers
static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательский макрос.

из Macroable
static void mixin(object $mixin, bool $replace = true)

Смешать другой объект в класс.

из Macroable
static bool hasMacro(string $name)

Проверить, зарегистрирован ли макрос.

из Macroable
static void flushMacros()

Очистить существующие макросы.

из Macroable
static mixed __callStatic(string $method, array $parameters)

Динамически обрабатывать вызовы класса.

из Macroable
mixed __call(string $method, array $parameters)

Динамически обрабатывать вызовы класса.

из Macroable
void __construct(callable $callback, Request $request, UserProvider $provider = null)

Создать новый охранник аутентификации.

Authenticatable|null user()

Получить текущего аутентифицированного пользователя.

bool validate(array $credentials = [])

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

$this setRequest(Request $request)

Установить текущий экземпляр запроса.

Подробности

Authenticatable authenticate()

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

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

Authenticatable

Исключения

AuthenticationException

bool hasUser()

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

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

bool

bool check()

Определить, аутентифицирован ли текущий пользователь.

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

bool

bool guest()

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

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

bool

int|string|null id()

Получить ID для текущего аутентифицированного пользователя.

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

int|string|null

$this setUser(Authenticatable $user)

Установить текущего пользователя.

Параметры

Authenticatable $user

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

$this
END_OF_DOCUMENT_MARKER

Провайдер пользователей getProvider()

Получить провайдер пользователей, используемый охранником.

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

Провайдер пользователей

void setProvider(Провайдер пользователей $provider)

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

Параметры

Провайдер пользователей $provider

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

void

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательское макроопределение.

Параметры

string $name
object|callable $macro

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

void

static void mixin(object $mixin, bool $replace = true)

Добавить другой объект в класс.

Параметры

object $mixin
bool $replace

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

void

Исключения

ReflectionException

static bool hasMacro(string $name)

Проверить, зарегистрировано ли макроопределение.

Параметры

string $name

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

bool

static void flushMacros()

Очистить существующие макроопределения.

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

void

static mixed __callStatic(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Параметры

string $method
array $parameters

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

mixed

Исключения

BadMethodCallException

void __construct(callable $callback, Запрос $request, Провайдер пользователей $provider = null)

Создать новый охранник аутентификации.

Параметры

callable $callback
Запрос $request
Провайдер пользователей $provider

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

void

Аутентифицируемый объект|null user()

Получить текущего аутентифицированного пользователя.

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

Аутентифицируемый объект|null

bool validate(array $credentials = [])

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

Параметры

array $credentials

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

bool

$this setRequest(Запрос $request)

Установить текущий экземпляр запроса.

Параметры

Запрос $request

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

$this

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/8.x/Illuminate/Auth/RequestGuard.html

Spec-Zone.ru

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