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

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

из GuardHelpers

bool

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

из GuardHelpers

bool

check()

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

из GuardHelpers

bool

guest()

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

из GuardHelpers

int|string|null

id()

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

из GuardHelpers

$this

setUser(Authenticatable $user)

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

из GuardHelpers

$this

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

из GuardHelpers

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

из GuardHelpers

void

setProvider(UserProvider $provider)

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

из GuardHelpers

static void

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

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

static void

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

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

static bool

hasMacro(string $name)

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

static void

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

static mixed

__callStatic(string $method, array $parameters)

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

mixed

__call(string $method, array $parameters)

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

void

__construct(callable $callback, Request $request, UserProvider|null $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

$this forgetUser()

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

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

$this

UserProvider getProvider()

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

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

void setProvider(UserProvider $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 $request, UserProvider|null $provider = null)

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

Параметры

callable	$callback
Request	$request
UserProvider\|null	$provider

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

void

Authenticatable|null user()

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

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

Authenticatable|null

bool validate(array $credentials = [])

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

Параметры

array

$credentials

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

bool

$this setRequest(Request $request)

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

Параметры

$request

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

$this

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

спецификации, руководства, описания, API

free hit counter