SessionGuard
class SessionGuard implements StatefulGuard, SupportsBasicAuth (View source)
Методы
| GuardHelpers | Эти методы обычно одинаковы для всех защит. |
| Macroable |
Свойства
| protected Authenticatable | $user | Текущий аутентифицированный пользователь. | from GuardHelpers |
| protected UserProvider | $provider | Реализация поставщика пользователей. | from GuardHelpers |
| static protected array | $macros | Зарегистрированные строковые макросы. | from Macroable |
| protected string | $name | Имя защиты. Обычно "session". | |
| protected Authenticatable | $lastAttempted | Пользователь, которого мы пытались получить последним. | |
| protected bool | $viaRemember | Указывает, был ли пользователь аутентифицирован через куки recaller. | |
| protected Session | $session | Сессия, используемая защитой. | |
| protected QueueingFactory | $cookie | Служба создания куки Illuminate. | |
| protected Request | $request | Экземпляр запроса. | |
| protected Dispatcher | $events | Экземпляр диспетчера событий. | |
| protected bool | $loggedOut | Указывает, был ли вызван метод выхода. | |
| protected bool | $recallAttempted | Указывает, была ли попытка извлечения пользователя по токену. |
Методы
| Authenticatable | authenticate() Определить, авторизован ли текущий пользователь. Если нет, выбросить исключение. | from GuardHelpers |
| bool | hasUser() Определить, имеет ли страж экземпляр пользователя. | from GuardHelpers |
| bool | check() Определить, авторизован ли текущий пользователь. | from GuardHelpers |
| bool | guest() Определить, является ли текущий пользователь гостем. | from GuardHelpers |
| int|string|null | id() Получить ID текущего авторизованного пользователя. | |
| void | setUser(Authenticatable $user) Установить текущего пользователя. | |
| UserProvider | getProvider() Получить поставщика пользователей, используемого стражем. | from GuardHelpers |
| void | setProvider(UserProvider $provider) Установить поставщика пользователей, используемого стражем. | from GuardHelpers |
| static void | macro(string $name, object|callable $macro) Зарегистрировать пользовательское макрокоманду. | from Macroable |
| static void | mixin(object $mixin, bool $replace = true) Добавить другой объект в класс. | from Macroable |
| static bool | hasMacro(string $name) Проверяет, зарегистрирована ли макрокоманда. | from Macroable |
| static mixed | __callStatic(string $method, array $parameters) Динамически обрабатывать вызовы класса. | from Macroable |
| mixed | __call(string $method, array $parameters) Динамически обрабатывать вызовы класса. | from Macroable |
| void | __construct(string $name, UserProvider $provider, Session $session, Request $request = null) Создать новый страж аутентификации. | |
| Authenticatable|null | user() Получить текущего авторизованного пользователя. | |
| mixed | userFromRecaller(Recaller $recaller) Извлечь пользователя из хранилища по токену куки «запомнить меня». | |
| Recaller|null | recaller() Получить расшифрованный куки-файл recaller для запроса. | |
| bool | once(array $credentials = []) Войти в систему пользователю без сеансов или файлов cookie. | |
| bool | onceUsingId(mixed $id) Войти в систему с заданным ID пользователя без сеансов или файлов cookie. | |
| 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 | basicCredentials(Request $request, string $field) Получить массив учетных данных для запроса HTTP Basic. | |
| void | failedBasicResponse() Получить ответ для базовой аутентификации. | |
| bool | attempt(array $credentials = [], bool $remember = false) Попытка аутентификации пользователя с помощью заданных учетных данных. | |
| bool | hasValidCredentials(mixed $user, array $credentials) Определить, соответствует ли пользователь учетным данным. | |
| Authenticatable | loginUsingId(mixed $id, bool $remember = false) Войти в систему с заданным ID пользователя. | |
| void | login(Authenticatable $user, bool $remember = false) Войти в систему пользователю. | |
| void | updateSession(string $id) Обновить сеанс с заданным ID. | |
| void | ensureRememberTokenIsSet(Authenticatable $user) Создать новый токен «запомнить меня» для пользователя, если он ещё не существует. | |
| void | queueRecallerCookie(Authenticatable $user) Выстроить в очередь куки-файл recaller в хранилище файлов cookie. | |
| Cookie | createRecaller(string $value) Создать куки-файл «запомнить меня» для заданного ID. | |
| void | logout() Выйти из системы для пользователя. | |
| void | clearUserDataFromStorage() Удалить данные пользователя из сеанса и файлов cookie. | |
| void | cycleRememberToken(Authenticatable $user) Обновить токен «запомнить меня» для пользователя. | |
| bool|null | logoutOtherDevices(string $password, string $attribute = 'password') Удалить другие сеансы для текущего пользователя. |
| void | attempting(mixed $callback) Зарегистрировать обработчик события попытки аутентификации. | |
| void | fireAttemptEvent(array $credentials, bool $remember = false) Вызвать событие попытки с аргументами. | |
| void | fireLoginEvent(Authenticatable $user, bool $remember = false) Вызвать событие входа, если диспетчер установлен. | |
| void | fireAuthenticatedEvent(Authenticatable $user) Вызвать событие авторизации, если диспетчер установлен. | |
| void | fireOtherDeviceLogoutEvent(Authenticatable $user) Вызвать событие выхода с другого устройства, если диспетчер установлен. | |
| void | fireFailedEvent(Authenticatable|null $user, array $credentials) Вызвать событие неудачной попытки аутентификации с заданными аргументами. | |
| Authenticatable | getLastAttempted() Получить последнего пользователя, для которого была попытка аутентификации. | |
| string | getName() Получить уникальный идентификатор для значения сессии аутентификации. | |
| string | getRecallerName() Получить имя куки, используемого для хранения "recaller". | |
| bool | viaRemember() Определить, был ли пользователь авторизован с помощью куки "запомнить меня". | |
| QueueingFactory | getCookieJar() Получить экземпляр создателя куки, используемый стражем. | |
| void | setCookieJar(QueueingFactory $cookie) Установить экземпляр создателя куки, используемый стражем. | |
| Dispatcher | getDispatcher() Получить экземпляр диспетчера событий. | |
| void | setDispatcher(Dispatcher $events) Установить экземпляр диспетчера событий. | |
| Session | getSession() Получить хранилище сессий, используемое стражем. | |
| Authenticatable|null | getUser() Возвращает текущего кэшированного пользователя. | |
| Request | getRequest() Получить текущий экземпляр запроса. | |
| $this | setRequest(Request $request) Установить текущий экземпляр запроса. |
Подробности
Authenticatable authenticate()
Определить, авторизован ли текущий пользователь. В противном случае выбросить исключение.
bool hasUser()
Определить, имеет ли страж экземпляр пользователя.
bool check()
Определить, авторизован ли текущий пользователь.
bool guest()
Определить, является ли текущий пользователь гостем.
int|string|null id()
Получить ID текущего авторизованного пользователя.
void setUser(Authenticatable $user)
Установить текущего пользователя.
UserProvider getProvider()
Получить поставщика пользователей, используемого стражем.
void setProvider(UserProvider $provider)
Установить поставщика пользователей, используемого стражем.
static void macro(string $name, object|callable $macro)
Зарегистрировать пользовательское макро.
static void mixin(object $mixin, bool $replace = true)
Смешать другой объект в класс.
static bool hasMacro(string $name)
Проверяет, зарегистрировано ли макро.
static mixed __callStatic(string $method, array $parameters)
Динамически обрабатывает вызовы класса.
mixed __call(string $method, array $parameters)
Динамически обрабатывает вызовы класса.
void __construct(string $name, UserProvider $provider, Session $session, Request $request = null)
Создать новый страж аутентификации.
Authenticatable|null user()
Получить текущего авторизованного пользователя.
protected mixed userFromRecaller(Recaller $recaller)
Получить пользователя из репозитория по токену куки "запомнить меня".
protected Recaller|null recaller()
Получить расшифрованный recaller куки для запроса.
bool once(array $credentials = [])
Войти в систему пользователю без сессий или куки.
bool onceUsingId(mixed $id)
Войти в систему с указанным идентификатором пользователя без сессий или куки.
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 Auth.
protected bool attemptBasic(Request $request, string $field, array $extraConditions = [])
Попытка аутентификации с помощью базовой аутентификации.
protected array basicCredentials(Request $request, string $field)
Получить массив учетных данных для запроса HTTP Basic.
protected void failedBasicResponse()
Получить ответ для базовой аутентификации.
bool attempt(array $credentials = [], bool $remember = false)
Попытка аутентификации пользователя с предоставленными учетными данными.
protected bool hasValidCredentials(mixed $user, array $credentials)
Определить, соответствует ли пользователь предоставленным учетным данным.
Authenticatable loginUsingId(mixed $id, bool $remember = false)
Вход в систему с указанным идентификатором пользователя.
void login(Authenticatable $user, bool $remember = false)
Войти в систему пользователю.
protected void updateSession(string $id)
Обновить сеанс с заданным ID.
protected void ensureRememberTokenIsSet(Authenticatable $user)
Создать новый токен "запомнить меня" для пользователя, если он ещё не существует.
protected void queueRecallerCookie(Authenticatable $user)
Добавить куки recaller в хранилище куки.
protected Cookie createRecaller(string $value)
Создать куки "запомнить меня" для данного ID.
void logout()
Вывести пользователя из приложения.
protected void clearUserDataFromStorage()
Удалить данные пользователя из сеанса и куки.
protected void cycleRememberToken(Authenticatable $user)
Обновить токен "запомнить меня" для пользователя.
bool|null logoutOtherDevices(string $password, string $attribute = 'password')
Отключить другие сеансы для текущего пользователя.
Приложению необходимо использовать middleware AuthenticateSession.
void attempting(mixed $callback)
Зарегистрировать слушатель события попытки аутентификации.
protected void fireAttemptEvent(array $credentials, bool $remember = false)
Вызвать событие попытки с заданными аргументами.
protected void fireLoginEvent(Authenticatable $user, bool $remember = false)
Вызвать событие входа, если диспетчер установлен.
protected void fireAuthenticatedEvent(Authenticatable $user)
Вызвать событие аутентификации, если диспетчер установлен.
protected void fireOtherDeviceLogoutEvent(Authenticatable $user)
Вызвать событие выхода из других устройств, если диспетчер установлен.
protected void fireFailedEvent(Authenticatable|null $user, array $credentials)
Вызвать событие неудачной попытки аутентификации с указанными аргументами.
Authenticatable getLastAttempted()
Получить последнего пользователя, для которого проводилась попытка аутентификации.
string getName()
Получить уникальный идентификатор для значения сеанса аутентификации.
string getRecallerName()
Получить имя куки, используемой для хранения "recaller".
bool viaRemember()
Определить, был ли пользователь аутентифицирован через куки "запомнить меня".
QueueingFactory getCookieJar()
Получить экземпляр создателя куки, используемый стражем.
void setCookieJar(QueueingFactory $cookie)
Установить экземпляр создателя cookie, используемый стражем.
Dispatcher getDispatcher()
Получить экземпляр диспетчера событий.
void setDispatcher(Dispatcher $events)
Установить экземпляр диспетчера событий.
Session getSession()
Получить хранилище сеансов, используемое стражем.
Authenticatable|null getUser()
Возвращает текущего кэшированного пользователя.
Request getRequest()
Получить текущий экземпляр запроса.
$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/SessionGuard.html
