TokenGuard
класс TokenGuard реализует Guard (View source)
Черты
| GuardHelpers | Эти методы обычно одинаковы для всех стражей. |
Свойства
| protected Authenticatable|null | $user | Текущий аутентифицированный пользователь. | из GuardHelpers |
| protected UserProvider | $provider | Реализация поставщика пользователей. | из GuardHelpers |
| protected Request | $request | Экземпляр запроса. | |
| protected string | $inputKey | Имя элемента строки запроса из запроса, содержащего токен API. | |
| protected string | $storageKey | Имя столбца токена в постоянном хранилище. | |
| protected bool | $hash | Указывает, является ли токен API хэшированным в хранилище. |
Методы
| Authenticatable | authenticate()
Определяет, аутентифицирован ли текущий пользователь. В противном случае, выбрасывает исключение. | из GuardHelpers |
| bool | hasUser()
Определяет, есть ли у стража экземпляр пользователя. | из GuardHelpers |
| bool | check()
Определяет, аутентифицирован ли текущий пользователь. | из GuardHelpers |
| bool | guest()
Определяет, является ли текущий пользователь гостем. | из GuardHelpers |
| int|string|null | id()
Получает ID для текущего аутентифицированного пользователя. | из GuardHelpers |
| $this | setUser(Authenticatable $user)
Устанавливает текущего пользователя. | из GuardHelpers |
| $this | forgetUser()
Забывает текущего пользователя. | из GuardHelpers |
| UserProvider | getProvider()
Получает поставщика пользователей, используемого стражем. | из GuardHelpers |
| void | setProvider(UserProvider $provider)
Устанавливает поставщика пользователей, используемого стражем. | из 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()
Определяет, аутентифицирован ли текущий пользователь. В противном случае, выбрасывает исключение.
bool hasUser()
Определяет, есть ли у стража экземпляр пользователя.
bool check()
Определяет, аутентифицирован ли текущий пользователь.
bool guest()
Определяет, является ли текущий пользователь гостем.
int|string|null id()
Получает ID для текущего аутентифицированного пользователя.
$this setUser(Authenticatable $user)
Устанавливает текущего пользователя.
$this forgetUser()
Забывает текущего пользователя.
UserProvider getProvider()
Получает поставщика пользователей, используемого стражем.
void setProvider(UserProvider $provider)
Устанавливает поставщика пользователей, используемого стражем.
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)
Установить текущий экземпляр запроса.
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/9.x/Illuminate/Auth/TokenGuard.html
