SessionGuard
class SessionGuard implements StatefulGuard, SupportsBasicAuth (View source)
Свойства
| GuardHelpers | Эти методы обычно одинаковы для всех охранников. |
Свойства
| protected Authenticatable | $user | Текущий аутентифицированный пользователь. | from GuardHelpers |
| protected UserProvider | $provider | Реализация поставщика пользователей. | from GuardHelpers |
| protected string | $name | Имя охранника. Обычно "session". | |
| protected Authenticatable | $lastAttempted | Пользователь, которого мы пытались получить последним. | |
| protected bool | $viaRemember | Указывает, был ли пользователь аутентифицирован через куки-файлы запоминания. | |
| protected SessionInterface | $session | Сессия, используемая охранником. | |
| protected QueueingFactory | $cookie | Сервис создания куки-файлов Illuminate. | |
| protected Request | $request | Экземпляр запроса. | |
| protected Dispatcher | $events | Экземпляр диспетчера событий. | |
| protected bool | $loggedOut | Указывает, был ли вызван метод выхода. | |
| protected bool | $tokenRetrievalAttempted | Указывает, была ли предпринята попытка извлечения пользователя по токену. |
Методы
| Authenticatable | authenticate() Определить, авторизован ли текущий пользователь. | из GuardHelpers |
| bool | check() Определить, авторизован ли текущий пользователь. | из GuardHelpers |
| bool | guest() Определить, является ли текущий пользователь гостем. | из GuardHelpers |
| int|null | id() Получить ID текущего авторизованного пользователя. | |
| void | setUser(Authenticatable $user) Установить текущего пользователя. | |
| void | __construct(string $name, UserProvider $provider, SessionInterface $session, Request $request = null) Создать новый охранник аутентификации. | |
| Authenticatable|null | user() Получить текущего авторизованного пользователя. | |
| mixed | getUserByRecaller(string $recaller) Извлечь пользователя из репозитория по его ID рекаллера. | |
| string|null | getRecaller() Получить расшифрованный куки рекаллера для запроса. | |
| string|null | getRecallerId() Получить ID пользователя из куки рекаллера. | |
| bool | validRecaller(mixed $recaller) Определить, находится ли куки рекаллера в корректном формате. | |
| bool | once(array $credentials = []) Произвести вход пользователя в приложение без сессий или куки. | |
| bool | validate(array $credentials = []) Проверить данные пользователя. | |
| Response|null | basic(string $field = 'email', array $extraConditions = []) Попытка аутентификации с помощью HTTP Basic Auth. | |
| Response|null | onceBasic(string $field = 'email', array $extraConditions = []) Выполнение попытки бессостоятельной аутентификации HTTP Basic. | |
| bool | attemptBasic(Request $request, string $field, array $extraConditions = []) Попытка аутентификации с помощью базовой аутентификации. | |
| 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 | fireFailedEvent(Authenticatable|null $user, array $credentials) Вызвать событие неудачной попытки аутентификации с заданными аргументами. | |
| 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() Возвращает текущего кэшированного пользователя. | |
| Request | getRequest() Получить текущий экземпляр запроса. | |
| $this | setRequest(Request $request) Установить текущий экземпляр запроса. | |
| Authenticatable | getLastAttempted() Получить последнего пользователя, для которого пытались выполнить аутентификацию. | |
| string | getName() Получить уникальный идентификатор для значения сеанса аутентификации. | |
| string | getRecallerName() Получить имя куки, используемого для хранения «recaller». | |
| bool | viaRemember() Определить, был ли пользователь аутентифицирован с помощью куки «запомнить меня». |
Подробности
Authenticatable authenticate()
Определить, аутентифицирован ли текущий пользователь.
bool check()
Определить, аутентифицирован ли текущий пользователь.
bool guest()
Определить, является ли текущий пользователь гостем.
int|null id()
Получить ID текущего аутентифицированного пользователя.
void setUser(Authenticatable $user)
Установить текущего пользователя.
void __construct(string $name, UserProvider $provider, SessionInterface $session, Request $request = null)
Создать новый страж аутентификации.
Authenticatable|null user()
Получить текущего аутентифицированного пользователя.
protected mixed getUserByRecaller(string $recaller)
Получить пользователя из репозитория по его идентификатору recaller.
protected string|null getRecaller()
Получить дешифрованный куки recaller для запроса.
protected string|null getRecallerId()
Получить ID пользователя из куки recaller.
protected bool validRecaller(mixed $recaller)
Определить, находится ли куки recaller в корректном формате.
bool once(array $credentials = [])
Выполнить вход пользователя в приложение без сессий или куки.
bool validate(array $credentials = [])
Проверить учётные данные пользователя.
Response|null basic(string $field = 'email', array $extraConditions = [])
Попытка аутентификации с помощью HTTP Basic Auth.
Response|null onceBasic(string $field = 'email', array $extraConditions = [])
Выполнить попытку входа с HTTP Basic без сохранения состояния.
protected bool attemptBasic(Request $request, string $field, array $extraConditions = [])
Попытка аутентификации с помощью базовой аутентификации.
protected array getBasicCredentials(Request $request, string $field)
Получить массив учётных данных для HTTP Basic запроса.
protected Response getBasicResponse()
Получить ответ для базовой аутентификации.
bool attempt(array $credentials = [], bool $remember = false, bool $login = true)
Попытка аутентификации пользователя с использованием предоставленных учетных данных.
protected bool hasValidCredentials(mixed $user, array $credentials)
Определить, соответствует ли пользователь предоставленным учетным данным.
protected void fireAttemptEvent(array $credentials, bool $remember, bool $login)
Вызвать событие попытки с указанными аргументами.
protected void fireFailedEvent(Authenticatable|null $user, array $credentials)
Вызвать событие неудачной попытки аутентификации с заданными аргументами.
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 recaller в 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()
Возвратить текущего кэшированного пользователя.
Request getRequest()
Получить текущий экземпляр запроса.
$this setRequest(Request $request)
Установить текущий экземпляр запроса.
Authenticatable getLastAttempted()
Получить последнего пользователя, для которого была предпринята попытка аутентификации.
string getName()
Получить уникальный идентификатор для значения сеанса аутентификации.
string getRecallerName()
Получить имя cookie, используемого для хранения "recaller".
bool viaRemember()
Определить, был ли пользователь аутентифицирован с помощью cookie "запомнить меня".
© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/5.2/Illuminate/Auth/SessionGuard.html
