TokenGuard

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

Свойства

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

Свойства

protected Authenticatable\|null	$user	Текущий аутентифицированный пользователь.	из GuardHelpers
protected UserProvider	$provider	Реализация поставщика пользователей.	из GuardHelpers
static protected array	$macros	Зарегистрированные строковые макросы.	из Macroable
protected Request	$request	Экземпляр запроса.
protected string	$inputKey	Имя элемента строки запроса из запроса, содержащего токен API.
protected string	$storageKey	Имя "столбца" токена в постоянном хранилище.
protected bool	$hash	Указывает, захеширован ли токен API в хранилище.

Методы

Authenticatable

authenticate()

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

from GuardHelpers

bool

hasUser()

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

from GuardHelpers

bool

check()

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

from GuardHelpers

bool

guest()

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

from GuardHelpers

int|string|null

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(UserProvider $provider, Request $request, string $inputKey = 'api_token', string $storageKey = 'api_token', bool $hash = false)

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

Authenticatable|null

user()

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

string|null

getTokenForRequest()

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

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

$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(UserProvider $provider, Request $request, string $inputKey = 'api_token', string $storageKey = 'api_token', bool $hash = false)

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

Параметры

UserProvider	$provider
Request	$request
string	$inputKey
string	$storageKey
bool	$hash

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

void

Authenticatable|null user()

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

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

Authenticatable|null

string|null getTokenForRequest()

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

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

string|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/11.x/Illuminate/Auth/TokenGuard.html