TokenGuard

class TokenGuard implements Guard (View source)

Свойства

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

Свойства

protected Authenticatable	$user	Текущий аутентифицированный пользователь.	from GuardHelpers
protected UserProvider	$provider	Реализация поставщика пользователей.	from GuardHelpers
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\|null	id() Получить ID текущего аутентифицированного пользователя.	from GuardHelpers
$this	setUser(Authenticatable $user) Установить текущего пользователя.	from GuardHelpers
UserProvider	getProvider() Получить поставщика пользователей, используемого стражем.	from GuardHelpers

void	setProvider(UserProvider $provider) Установить поставщика пользователей, используемого стражем.	from GuardHelpers
void	__construct(UserProvider $provider, Request $request, string $inputKey = 'api_token', string $storageKey = 'api_token', bool $hash = false) Создать новый страж аутентификации.
Authenticatable\|null	user() Получить текущего аутентифицированного пользователя.
string	getTokenForRequest() Получить токен для текущего запроса.
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)

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

Параметры

UserProvider

$provider

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

void

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

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

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

string

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