Spec-Zone.ru › Laravel 6

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|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 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|null id()

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

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

int|null

$this setUser(Authenticatable $user)

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

Параметры

Authenticatable $user

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

$this

UserProvider getProvider()

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

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

UserProvider

void setProvider(UserProvider $provider)

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

Parameters

UserProvider $provider

Return Value

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 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)

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

Parameters

Request $request

Return Value

$this

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

Spec-Zone.ru

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