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	Имя столбца токена в постоянном хранилище.

Методы

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') Создать новый страж аутентификации.
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')

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

Параметры

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

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

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