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 в хранилище. |
Свойства
| GuardHelpers | Эти методы обычно одинаковы для всех методов защиты. |
Методы
| 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()
Определить, авторизован ли текущий пользователь. Если нет, выбросить исключение.
bool hasUser()
Определить, имеет ли страж экземпляр пользователя.
bool check()
Определить, авторизован ли текущий пользователь.
bool guest()
Определить, является ли текущий пользователь гостем.
int|null id()
Получить 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/5.8/Illuminate/Auth/TokenGuard.html
