RequestGuard

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

Трейты

Эти методы обычно одинаковы для всех типов защиты.

Свойства

protected Authenticatable\|null	$user	Текущий аутентифицированный пользователь.	из GuardHelpers
protected UserProvider	$provider	Реализация поставщика пользователей.	из GuardHelpers
static protected array	$macros	Зарегистрированные строковые макросы.	из Macroable
protected callable	$callback	Обратный вызов защиты.
protected Request	$request	Экземпляр запроса.

Методы

Authenticatable	authenticate() Определить, авторизован ли текущий пользователь. Если нет, выбросить исключение.	from GuardHelpers
bool	hasUser() Определить, содержит ли объект провайдера экземпляр пользователя.	from GuardHelpers
bool	check() Определить, авторизован ли текущий пользователь.	from GuardHelpers
bool	guest() Определить, является ли текущий пользователь гостем.	from GuardHelpers
int\|string\|null	id() Получить ID текущего авторизованного пользователя.	from GuardHelpers
$this	setUser(Authenticatable $user) Установить текущего пользователя.	from GuardHelpers
$this	forgetUser() Удалить текущего пользователя.	from GuardHelpers
UserProvider	getProvider() Получить провайдер пользователей, используемый охранником.	from GuardHelpers
void	setProvider(UserProvider $provider) Установить провайдер пользователей, используемый охранником.	from GuardHelpers
static void	macro(string $name, object\|callable $macro) Зарегистрировать пользовательское макро.	from Macroable
static void	mixin(object $mixin, bool $replace = true) Смешать другой объект в класс.	from Macroable
static bool	hasMacro(string $name) Проверяет, зарегистрировано ли макро.	from Macroable
static void	flushMacros() Очистить существующие макросы.	from Macroable
static mixed	__callStatic(string $method, array $parameters) Динамически обработать вызовы к классу.	from Macroable
mixed	__call(string $method, array $parameters) Динамически обработать вызовы к классу.	from 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()

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

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

int|string|null

$this setUser(Authenticatable $user)

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

Параметры

Authenticatable

$user

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

$this

$this forgetUser()

Забыть текущего пользователя.

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

$this

UserProvider getProvider()

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

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

UserProvider

void setProvider(UserProvider $provider)

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

Параметры

UserProvider

$provider

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

void

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

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

Parameters

string	$name
object\|callable	$macro

Return Value

void

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

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

Parameters

object	$mixin
bool	$replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

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

Parameters

string

$name

Return Value

bool

static void flushMacros()

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

Return Value

void

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

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

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

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

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

Parameters

callable	$callback
Request	$request
UserProvider	$provider

Return Value

void

Authenticatable|null user()

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

Return Value

Authenticatable|null

bool validate(array $credentials = [])

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

Parameters

array

$credentials

Return Value

bool

$this setRequest(Request $request)

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

Параметры

Request

$request

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

$this

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