Spec-Zone.ru › Laravel 10

RequestGuard

class RequestGuard implements Guard (View source)

Трейты

GuardHelpers

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

Macroable

Свойства

protected Authenticatable|null $user

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

from GuardHelpers
protected UserProvider $provider

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

from GuardHelpers
static protected array $macros

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

from Macroable
protected callable $callback

Обратный вызов охранника.

protected Request $request

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

Методы

Authenticatable authenticate()

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

из GuardHelpers
bool hasUser()

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

из GuardHelpers
bool check()

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

из GuardHelpers
bool guest()

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

из GuardHelpers
int|string|null id()

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

из GuardHelpers
$this setUser(Authenticatable $user)

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

из GuardHelpers
$this forgetUser()

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

из 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()

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

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

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)

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

Параметры

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 $provider = null)

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

Параметры

callable $callback
Request $request
UserProvider $provider

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

void

Authenticatable|null user()

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

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

Authenticatable|null

bool validate(array $credentials = [])

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

Параметры

array $credentials

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

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/10.x/Illuminate/Auth/RequestGuard.html

Spec-Zone.ru

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