TokenGuard
class TokenGuard implements Guard (View source)
Свойства
| GuardHelpers | Эти методы обычно одинаковы для всех провайдеров. |
Свойства
| 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|string|null | 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()
Определяет, является ли текущий пользователь аутентифицированным. В противном случае, выбросить исключение.
bool hasUser()
Определяет, есть ли у провайдера экземпляр пользователя.
bool check()
Определяет, является ли текущий пользователь аутентифицированным.
bool guest()
Определяет, является ли текущий пользователь гостем.
int|string|null id()
Получить идентификатор текущего аутентифицированного пользователя.
$this setUser(Authenticatable $user)
Установить текущего пользователя.
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/8.x/Illuminate/Auth/TokenGuard.html
