Spec-Zone.ru › Laravel 5.6

TokenGuard

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

Черты

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

Свойства

protected Authenticatable $user Текущий аутентифицированный пользователь. из GuardHelpers
protected UserProvider $provider Реализация поставщика пользователей. из GuardHelpers
protected Request $request Экземпляр запроса.
protected string $inputKey Имя элемента строки запроса из запроса, содержащего токен API.
protected string $storageKey Имя столбца токена в постоянном хранилище.

Методы

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

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

Spec-Zone.ru

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