Guard
class Guard implements Guard (View source)
Свойства
| protected Authenticatable | $user | Текущий аутентифицированный пользователь. | |
| protected Authenticatable | $lastAttempted | Пользователь, которого мы последним пытались получить. | |
| protected bool | $viaRemember | Указывает, был ли пользователь аутентифицирован с помощью куки-файла для запоминания. | |
| protected UserProvider | $provider | Реализация поставщика пользователей. | |
| protected SessionInterface | $session | Сессия, используемая защитником. | |
| protected QueueingFactory | $cookie | Сервис создания куки-файлов Illuminate. | |
| protected Request | $request | Экземпляр запроса. | |
| protected Dispatcher | $events | Экземпляр диспетчера событий. | |
| protected bool | $loggedOut | Указывает, был ли вызван метод выхода. | |
| protected bool | $tokenRetrievalAttempted | Указывает, была ли попытка получения пользователя по токену. |
Методы
| void | __construct(UserProvider $provider, SessionInterface $session, Request $request = null) Создать новую стражу аутентификации. | |
| bool | check() Определить, является ли текущий пользователь аутентифицированным. | |
| bool | guest() Определить, является ли текущий пользователь гостем. | |
| Authenticatable|null | user() Получить текущего аутентифицированного пользователя. | |
| int|null | id() Получить ID текущего аутентифицированного пользователя. | |
| mixed | getUserByRecaller(string $recaller) Получить пользователя из репозитория по его ID вызывающего. | |
| string|null | getRecaller() Получить расшифрованный куки вызывающего для запроса. | |
| string|null | getRecallerId() Получить ID пользователя из куки вызывающего. | |
| bool | validRecaller(string $recaller) Определить, находится ли куки вызывающего в корректном формате. | |
| bool | once(array $credentials = []) Авторизовать пользователя в приложении без сессий или куков. | |
| bool | validate(array $credentials = []) Проверить учетные данные пользователя. | |
| Response|null | basic(string $field = 'email') Попытка аутентификации с помощью HTTP Basic Auth. | |
| Response|null | onceBasic(string $field = 'email') Выполнить бессостоятельную попытку входа с помощью HTTP Basic. | |
| bool | attemptBasic(Request $request, string $field) Попытка аутентификации с помощью базовой аутентификации. | |
| array | getBasicCredentials(Request $request, string $field) Получить массив учетных данных для HTTP Basic запроса. | |
| Response | getBasicResponse() Получить ответ для базовой аутентификации. | |
| bool | attempt(array $credentials = [], bool $remember = false, bool $login = true) Попытка аутентификации пользователя с использованием предоставленных учетных данных. | |
| bool | hasValidCredentials(mixed $user, array $credentials) Определить, соответствует ли пользователь учетным данным. | |
| void | fireAttemptEvent(array $credentials, bool $remember, bool $login) Вызвать событие попытки с аргументами. | |
| void | attempting(mixed $callback) Зарегистрировать обработчик событий попытки аутентификации. | |
| void | login(Authenticatable $user, bool $remember = false) Авторизовать пользователя в приложении. | |
| void | fireLoginEvent(Authenticatable $user, bool $remember = false) Вызвать событие входа, если диспетчер установлен. | |
| void | updateSession(string $id) Обновить сессию с заданным ID. | |
| Authenticatable | loginUsingId(mixed $id, bool $remember = false) Авторизовать пользователя с заданным ID в приложении. | |
| bool | onceUsingId(mixed $id) Авторизовать пользователя с заданным ID в приложении без сессий или куков. | |
| void | queueRecallerCookie(Authenticatable $user) Поместить куки вызывающего в очередь. | |
| Cookie | createRecaller(string $value) Создать куки "запомнить меня" для заданного ID. | |
| void | logout() Вывести пользователя из приложения. | |
| void | clearUserDataFromStorage() Удалить данные пользователя из сессии и куков. | |
| void | refreshRememberToken(Authenticatable $user) Обновить токен "запомнить меня" для пользователя. | |
| void | createRememberTokenIfDoesntExist(Authenticatable $user) Создать новый токен "запомнить меня" для пользователя, если он не существует. | |
| QueueingFactory | getCookieJar() Получить экземпляр создателя куков, используемый стражей. | |
| void | setCookieJar(QueueingFactory $cookie) Установить экземпляр создателя куков, используемый стражей. | |
| Dispatcher | getDispatcher() Получить экземпляр диспетчера событий. | |
| void | setDispatcher(Dispatcher $events) Установить экземпляр диспетчера событий. | |
| Store | getSession() Получить хранилище сессий, используемое стражей. | |
| UserProvider | getProvider() Получить поставщика пользователей, используемого стражей. | |
| void | setProvider(UserProvider $provider) Установить поставщика пользователей, используемого стражей. | |
| Authenticatable|null | getUser() Возвратить текущего кэшированного пользователя. | |
| void | setUser(Authenticatable $user) Установить текущего пользователя. | |
| Request | getRequest() Получить текущий экземпляр запроса. | |
| $this | setRequest(Request $request) Установить текущий экземпляр запроса. |
| Авторизуемый | getLastAttempted() Получить последнюю попытку авторизации пользователя. | |
| строка | getName() Получить уникальный идентификатор для значения сессии авторизации. | |
| строка | getRecallerName() Получить имя куки, используемой для хранения «recaller». | |
| логическое | viaRemember() Определить, был ли пользователь авторизован с помощью куки «запомнить меня». |
Подробности
void __construct(UserProvider $provider, SessionInterface $session, Request $request = null)
Создать новый объект для проверки подлинности.
логическое check()
Определить, авторизован ли текущий пользователь.
логическое guest()
Определить, является ли текущий пользователь гостем.
Авторизуемый|null user()
Получить текущего авторизованного пользователя.
int|null id()
Получить ID текущего авторизованного пользователя.
protected mixed getUserByRecaller(string $recaller)
Получить пользователя из репозитория по его ID recaller.
protected строка|null getRecaller()
Получить расшифрованный куки recaller для запроса.
protected строка|null getRecallerId()
Получить ID пользователя из куки recaller.
protected логическое validRecaller(string $recaller)
Определить, находится ли куки recaller в корректном формате.
логическое once(array $credentials = [])
Авторизовать пользователя в приложении без сессий или куки.
логическое validate(array $credentials = [])
Проверить учетные данные пользователя.
Response|null basic(string $field = 'email')
Попытка авторизации с использованием HTTP Basic Auth.
Response|null onceBasic(string $field = 'email')
Выполнить попытку одноразового HTTP Basic входа.
protected логическое attemptBasic(Request $request, string $field)
Попытка авторизации с использованием basic аутентификации.
protected массив getBasicCredentials(Request $request, string $field)
Получить массив учетных данных для запроса HTTP Basic.
protected Response getBasicResponse()
Получить ответ для basic аутентификации.
логическое attempt(array $credentials = [], bool $remember = false, bool $login = true)
Попытка авторизации пользователя с использованием предоставленных учетных данных.
protected логическое hasValidCredentials(mixed $user, array $credentials)
Определить, соответствует ли пользователь предоставленным учетным данным.
protected void fireAttemptEvent(array $credentials, bool $remember, bool $login)
Сгенерировать событие попытки с указанными аргументами.
void attempting(mixed $callback)
Регистрация обработчика событий попытки аутентификации.
void login(Authenticatable $user, bool $remember = false)
Войти в систему пользователя.
protected void fireLoginEvent(Authenticatable $user, bool $remember = false)
Вызвать событие входа в систему, если диспетчер установлен.
protected void updateSession(string $id)
Обновить сеанс с заданным ID.
Authenticatable loginUsingId(mixed $id, bool $remember = false)
Войти в систему с заданным ID пользователя.
bool onceUsingId(mixed $id)
Войти в систему с заданным ID пользователя без сеансов или файлов cookie.
protected void queueRecallerCookie(Authenticatable $user)
Добавить файл cookie авторизации в очередь.
protected Cookie createRecaller(string $value)
Создать файл cookie "запомнить меня" для заданного ID.
void logout()
Выйти из системы пользователя.
protected void clearUserDataFromStorage()
Удалить данные пользователя из сеанса и файлов cookie.
protected void refreshRememberToken(Authenticatable $user)
Обновить токен "запомнить меня" для пользователя.
protected void createRememberTokenIfDoesntExist(Authenticatable $user)
Создать новый токен "запомнить меня" для пользователя, если он еще не существует.
QueueingFactory getCookieJar()
Получить экземпляр создателя файлов cookie, используемый стражем.
void setCookieJar(QueueingFactory $cookie)
Установить экземпляр создателя файлов cookie, используемый стражем.
Dispatcher getDispatcher()
Получить экземпляр диспетчера событий.
void setDispatcher(Dispatcher $events)
Установить экземпляр диспетчера событий.
Store getSession()
Получить хранилище сеансов, используемое стражем.
UserProvider getProvider()
Получить поставщика пользователей, используемого стражем.
void setProvider(UserProvider $provider)
Установить поставщика пользователей, используемого стражем.
Authenticatable|null getUser()
Возвратить текущего кэшированного пользователя.
void setUser(Authenticatable $user)
Установить текущего пользователя.
Request getRequest()
Получить текущий экземпляр запроса.
$this setRequest(Request $request)
Установить текущий экземпляр запроса.
Authenticatable getLastAttempted()
Получить последнего пользователя, для которого пытались выполнить аутентификацию.
string getName()
Получить уникальный идентификатор для значения сессии аутентификации.
string getRecallerName()
Получить имя куки, используемого для хранения «recaller».
bool viaRemember()
Определить, был ли пользователь аутентифицирован с помощью куки «запомнить меня».
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.3/Illuminate/Auth/Guard.html
