SessionGuard

class SessionGuard implements StatefulGuard, SupportsBasicAuth (View source)

Трейты

Эти методы обычно одинаковы для всех систем авторизации.

Свойства

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	Указывает, был ли пользователь аутентифицирован с помощью куки-файла.
protected Session	$session	Сессия, используемая системой авторизации.
protected QueueingFactory	$cookie	Сервис создания куки-файлов Illuminate.
protected Request	$request	Экземпляр запроса.
protected Dispatcher	$events	Экземпляр диспетчера событий.
protected bool	$loggedOut	Указывает, был ли вызван метод выхода.
protected bool	$recallAttempted	Указывает, была ли попытка извлечения пользователя по токену.

Методы

Authenticatable	authenticate() Определить, авторизован ли текущий пользователь. Если нет, выбросить исключение.	из GuardHelpers
bool	hasUser() Определить, содержит ли провайдер пользователя.	из GuardHelpers
bool	check() Определить, авторизован ли текущий пользователь.	из GuardHelpers
bool	guest() Определить, является ли текущий пользователь гостем.	из GuardHelpers
int\|string\|null	id() Получить ID текущего авторизованного пользователя.
void	setUser(Authenticatable $user) Установить текущего пользователя.
UserProvider	getProvider() Получить провайдер пользователей, используемый провайдером.	из GuardHelpers
void	setProvider(UserProvider $provider) Установить провайдера пользователей, используемого провайдером.	из GuardHelpers
static void	macro(string $name, object\|callable $macro) Зарегистрировать пользовательское макро.	из Macroable
static void	mixin(object $mixin, bool $replace = true) Добавить другой объект в класс.	из Macroable
static bool	hasMacro(string $name) Проверяет, зарегистрировано ли макро.	из Macroable
static mixed	__callStatic(string $method, array $parameters) Динамически обрабатывает вызовы к классу.	из Macroable
mixed	__call(string $method, array $parameters) Динамически обрабатывает вызовы к классу.	из 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 = []) Авторизовать пользователя в приложении без сессий или куки.
bool	onceUsingId(mixed $id) Авторизовать заданный 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 аутентификации.
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	createRecaller(string $value) Создать куки "запомнить меня" для заданного ID.
void	logout() Выйти из приложения.
void	clearUserDataFromStorage() Удалить данные пользователя из сессии и куки.
void	cycleRememberToken(Authenticatable $user) Обновить токен "запомнить меня" для пользователя.
void	logoutCurrentDevice() Выйти из приложения только с текущего устройства.
bool\|null	logoutOtherDevices(string $password, string $attribute = 'password') Недействительность других сессий для текущего пользователя.

void	attempting(mixed $callback) Зарегистрировать слушателя событий попытки аутентификации.
void	fireAttemptEvent(array $credentials, bool $remember = false) Вызвать событие попытки с аргументами.
fireValidatedEvent($user) Вызывает событие валидации, если диспетчер установлен.
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() Получить имя cookie, используемого для хранения "recaller".
bool	viaRemember() Определить, был ли пользователь авторизован через cookie "запомнить меня".
QueueingFactory	getCookieJar() Получить экземпляр создателя cookie, используемый стражем.
void	setCookieJar(QueueingFactory $cookie) Установить экземпляр создателя cookie, используемый стражем.
Dispatcher	getDispatcher() Получить экземпляр диспетчера событий.
void	setDispatcher(Dispatcher $events) Установить экземпляр диспетчера событий.
Session	getSession() Получить хранилище сеансов, используемое стражем.
Authenticatable\|null	getUser() Возвращает текущего кэшированного пользователя.
Request	getRequest() Получить текущий экземпляр запроса.
$this	setRequest(Request $request) Установить текущий экземпляр запроса.

Подробности

Authenticatable authenticate()

Определить, авторизован ли текущий пользователь. Если нет, выбросить исключение.

Возвращаемое значение

Authenticatable

Исключения

AuthenticationException

bool hasUser()

Определить, имеет ли страж экземпляр пользователя.

Возвращаемое значение

bool

bool check()

Определить, авторизован ли текущий пользователь.

Возвращаемое значение

bool

bool guest()

Определить, является ли текущий пользователь гостем.

Возвращаемое значение

bool

int|string|null id()

Получить ID текущего авторизованного пользователя.

Возвращаемое значение

int|string|null

void setUser(Authenticatable $user)

Установить текущего пользователя.

Параметры

Authenticatable

$user

Возвращаемое значение

void

UserProvider getProvider()

Получить поставщик пользователей, используемый стражем.

Возвращаемое значение

UserProvider

void setProvider(UserProvider $provider)

Установить поставщик пользователей, используемый стражем.

Параметры

UserProvider

$provider

Возвращаемое значение

void

static void macro(string $name, object|callable $macro)

Зарегистрировать пользовательский макрос.

Параметры

string	$name
object\|callable	$macro

Возвращаемое значение

void

static void mixin(object $mixin, bool $replace = true)

Включить другой объект в класс.

Параметры

object	$mixin
bool	$replace

Возвращаемое значение

void

Исключения

ReflectionException

static bool hasMacro(string $name)

Проверка, зарегистрирован ли макрос.

Параметры

string

$name

Возвращаемое значение

bool

static mixed __callStatic(string $method, array $parameters)

Динамически обрабатывает вызовы класса.

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

mixed __call(string $method, array $parameters)

Динамически обрабатывает вызовы класса.

Parameters

string	$method
array	$parameters

Return Value

mixed

Exceptions

BadMethodCallException

void __construct(string $name, UserProvider $provider, Session $session, Request $request = null)

Создать новый объект для аутентификации.

Parameters

string	$name
UserProvider	$provider
Session	$session
Request	$request

Return Value

void

Authenticatable|null user()

Получить текущего аутентифицированного пользователя.

Return Value

Authenticatable|null

protected mixed userFromRecaller(Recaller $recaller)

Получить пользователя из хранилища по токену куки "запомнить меня".

Parameters

Recaller

$recaller

Return Value

mixed

protected Recaller|null recaller()

Получить расшифрованный токен куки recaller для запроса.

Return Value

Recaller|null

bool once(array $credentials = [])

Выполнить вход в систему без сессий и куки.

Parameters

array

$credentials

Return Value

bool

bool onceUsingId(mixed $id)

Выполнить вход в систему по ID пользователя без сессий и куки.

Parameters

mixed

$id

Return Value

bool

bool validate(array $credentials = [])

Проверить данные пользователя.

Parameters

array

$credentials

Return Value

bool

Response|null basic(string $field = 'email', array $extraConditions = [])

Попытка аутентификации с помощью HTTP Basic Auth.

Parameters

string	$field
array	$extraConditions

Return Value

Response|null

Response|null onceBasic(string $field = 'email', array $extraConditions = [])

Выполнить однократный HTTP Basic вход.

Parameters

string	$field
array	$extraConditions

Return Value

Response|null

protected bool attemptBasic(Request $request, string $field, array $extraConditions = [])

Попытка аутентификации с использованием базовой аутентификации.

Parameters

Request	$request
string	$field
array	$extraConditions

Return Value

bool

protected array basicCredentials(Request $request, string $field)

Получить массив данных для запроса HTTP Basic.

Parameters

Request	$request
string	$field

Return Value

array

protected void failedBasicResponse()

Получить ответ при ошибке базовой аутентификации.

Return Value

void

Exceptions

UnauthorizedHttpException

bool attempt(array $credentials = [], bool $remember = false)

Попытка аутентификации пользователя с заданными данными.

Parameters

array	$credentials
bool	$remember

Return Value

bool

protected bool hasValidCredentials(mixed $user, array $credentials)

Определить, соответствует ли пользователь предоставленным данным.

Parameters

mixed	$user
array	$credentials

Return Value

bool

Authenticatable loginUsingId(mixed $id, bool $remember = false)

Вход в систему по ID пользователя.

Parameters

mixed	$id
bool	$remember

Return Value

Authenticatable

void login(Authenticatable $user, bool $remember = false)

Вход в систему для пользователя.

Parameters

Authenticatable	$user
bool	$remember

Return Value

void

protected void updateSession(string $id)

Обновить сеанс с заданным ID.

Parameters

string

$id

Return Value

void

protected void ensureRememberTokenIsSet(Authenticatable $user)

Создать новый токен «запомнить меня» для пользователя, если он ещё не существует.

Parameters

Authenticatable

$user

Return Value

void

protected void queueRecallerCookie(Authenticatable $user)

Поместить куку «запомнить меня» в хранилище куки.

Parameters

Authenticatable

$user

Return Value

void

protected Cookie createRecaller(string $value)

Создать куку «запомнить меня» для данного ID.

Parameters

string

$value

Return Value

void logout()

Вывести пользователя из приложения.

Return Value

void

protected void clearUserDataFromStorage()

Удалить данные пользователя из сеанса и куки.

Return Value

void

protected void cycleRememberToken(Authenticatable $user)

Обновить токен «запомнить меня» для пользователя.

Parameters

Authenticatable

$user

Return Value

void

void logoutCurrentDevice()

Вывести пользователя из приложения только с текущего устройства.

Return Value

void

bool|null logoutOtherDevices(string $password, string $attribute = 'password')

Аннулировать другие сессии для текущего пользователя.

Приложение должно использовать middleware AuthenticateSession.

Parameters

string	$password
string	$attribute

Return Value

bool|null

void attempting(mixed $callback)

Зарегистрировать обработчик события попытки аутентификации.

Parameters

mixed

$callback

Return Value

void

protected void fireAttemptEvent(array $credentials, bool $remember = false)

Вызвать событие попытки с переданными аргументами.

Parameters

array	$credentials
bool	$remember

Return Value

void

protected fireValidatedEvent($user)

Вызвать событие валидации, если диспетчер установлен.

Parameters

$user

protected void fireLoginEvent(Authenticatable $user, bool $remember = false)

Вызвать событие входа в систему, если диспетчер установлен.

Parameters

Authenticatable	$user
bool	$remember

Return Value

void

protected void fireAuthenticatedEvent(Authenticatable $user)

Вызвать событие аутентификации, если диспетчер установлен.

Parameters

Authenticatable

$user

Return Value

void

protected void fireOtherDeviceLogoutEvent(Authenticatable $user)

Вызвать событие выхода из системы с другого устройства, если диспетчер установлен.

Parameters

Authenticatable

$user

Return Value

void

protected void fireFailedEvent(Authenticatable|null $user, array $credentials)

Вызвать событие неудачной попытки аутентификации с заданными аргументами.

Parameters

Authenticatable\|null	$user
array	$credentials

Return Value

void

Authenticatable getLastAttempted()

Получить последнего пользователя, для которого пытались выполнить аутентификацию.

Return Value

Authenticatable

string getName()

Получить уникальный идентификатор для значения сеанса аутентификации.

Return Value

string

string getRecallerName()

Получить имя куки, используемой для хранения «recaller».

Return Value

string

bool viaRemember()

Определить, был ли пользователь аутентифицирован через куку «запомнить меня».

Return Value

bool

Очередь создания файлов cookie getCookieJar()

Получить экземпляр создателя файлов cookie, используемый стражем.

Значение возврата

Очередь создания файлов cookie

Исключения

RuntimeException

void setCookieJar(Очередь создания файлов cookie $cookie)

Установить экземпляр создателя файлов cookie, используемый стражем.

Параметры

Очередь создания файлов cookie

$cookie

Значение возврата

void

Диспечер событий getDispatcher()

Получить экземпляр диспечера событий.

Значение возврата

Диспечер событий

void setDispatcher(Диспечер событий $events)

Установить экземпляр диспечера событий.

Параметры

Диспечер событий

$events

Значение возврата

void

Сессия getSession()

Получить хранилище сессии, используемое стражем.

Значение возврата

Сессия

Пользователь|null getUser()

Возвратить текущего кэшированного пользователя.

Значение возврата

Пользователь|null

Запрос getRequest()

Получить текущий экземпляр запроса.

Значение возврата

Запрос

$this setRequest(Запрос $request)

Установить текущий экземпляр запроса.

Параметры

Запрос

$request

Значение возврата

$this

© Taylor Otwell
Licensed under the MIT License.
Laravel is a trademark of Taylor Otwell.
https://laravel.com/api/6.x/Illuminate/Auth/SessionGuard.html