SessionGuard

класс SessionGuard реализует StatefulGuard, SupportsBasicAuth (Просмотреть исходный код)

Свойства

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

Свойства

protected Authenticatable\|null	$user	Текущий аутентифицированный пользователь.	из GuardHelpers
protected UserProvider	$provider	Реализация поставщика пользователей.	из GuardHelpers
static protected array	$macros	Зарегистрированные строковые макросы.	из Macroable
protected string	$name	Имя механизма авторизации. Обычно "web".
protected Authenticatable	$lastAttempted	Пользователь, которого мы в последний раз пытались получить.
protected bool	$viaRemember	Указывает, был ли пользователь аутентифицирован с помощью куки-файла recaller.
protected int	$rememberDuration	Количество минут, в течение которых куки-файл "запомнить меня" должен быть действительным.
protected Session	$session	Сессия, используемая механизмом авторизации.
protected QueueingFactory	$cookie	Сервис создания куки-файлов Illuminate.
protected Request	$request	Экземпляр запроса.
protected Dispatcher	$events	Экземпляр диспетчера событий.
protected Timebox	$timebox	Экземпляр timebox.
protected bool	$loggedOut	Указывает, был ли вызван метод выхода из системы.
protected bool	$recallAttempted	Указывает, была ли предпринята попытка извлечения пользователя по токену.

Методы

Authenticatable	authenticate() Определить, авторизован ли текущий пользователь. Если нет, выбросить исключение.	из GuardHelpers
bool	hasUser() Определить, содержит ли страж экземпляр пользователя.	из GuardHelpers
bool	check() Определить, авторизован ли текущий пользователь.	из GuardHelpers
bool	guest() Определить, является ли текущий пользователь гостем.	из GuardHelpers
int\|string\|null	id() Получить идентификатор текущего авторизованного пользователя.
void	setUser(Authenticatable $user) Установить текущего пользователя.
$this	forgetUser() Забыть текущего пользователя.	из GuardHelpers
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 void	flushMacros() Очистить существующие макрокоманды.	из 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, Timebox $timebox = null) Создать новый страж аутентификации.
Authenticatable\|null	user() Получить текущего авторизованного пользователя.
mixed	userFromRecaller(Recaller $recaller) Извлечь пользователя из хранилища по токену куки "запомнить меня".
Recaller\|null	recaller() Получить расшифрованный куки recaller для запроса.
bool	once(array $credentials = []) Авторизовать пользователя в приложении без сессий или куки.
Authenticatable\|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 без состояния.
bool	attemptBasic(Request $request, string $field, array $extraConditions = []) Попытка авторизации с помощью basic аутентификации.
array	basicCredentials(Request $request, string $field) Получить массив учетных данных для HTTP Basic запроса.
void	failedBasicResponse() Получить ответ для basic аутентификации.
bool	attempt(array $credentials = [], bool $remember = false) Попытка авторизации пользователя с помощью заданных учетных данных.
bool	attemptWhen(array $credentials = [], array\|callable\|null $callbacks = null, bool $remember = false) Попытка авторизации пользователя с учетными данными и дополнительными обратными вызовами.
bool	hasValidCredentials(mixed $user, array $credentials) Определить, соответствует ли пользователь учетным данным.
bool	shouldLogin(array\|callable\|null $callbacks, Authenticatable $user) Определить, должен ли пользователь войти в систему, выполнив заданные обратные вызовы.
Authenticatable\|bool	loginUsingId(mixed $id, bool $remember = false) Авторизовать заданный идентификатор пользователя в приложении.
void	login(Authenticatable $user, bool $remember = false) Авторизовать пользователя в приложении.
void	updateSession(string $id) Обновить сессию с заданным идентификатором.
void	ensureRememberTokenIsSet(Authenticatable $user) Создать новый токен "запомнить меня" для пользователя, если он еще не существует.
void	queueRecallerCookie(Authenticatable $user) Добавить куки recaller в хранилище куки.

Cookie	createRecaller(string $value) Создать куки "запомнить меня" для данного идентификатора.
void	logout() Вывести пользователя из приложения.
void	logoutCurrentDevice() Вывести пользователя из приложения только на текущем устройстве.
void	clearUserDataFromStorage() Удалить данные пользователя из сессии и куки.
void	cycleRememberToken(Authenticatable $user) Обновить токен "запомнить меня" для пользователя.
Authenticatable\|null	logoutOtherDevices(string $password, string $attribute = 'password') Удалить другие сессии для текущего пользователя.
Authenticatable\|null	rehashUserPassword(string $password, string $attribute) Перехешировать пароль текущего пользователя.
void	attempting(mixed $callback) Регистрация слушателя событий попытки аутентификации.
void	fireAttemptEvent(array $credentials, bool $remember = false) Вызвать событие попытки с аргументами.
void	fireValidatedEvent(Authenticatable $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() Получить имя куки, используемой для хранения "recaller".
bool	viaRemember() Определить, был ли пользователь аутентифицирован через куки "запомнить меня".
int	getRememberDuration() Получить количество минут, в течение которых куки "запомнить меня" должны быть действительны.
$this	setRememberDuration(int $minutes) Установить количество минут, в течение которых куки "запомнить меня" должны быть действительны.
QueueingFactory	getCookieJar() Получить экземпляр создателя куки, используемый стражем.
void	setCookieJar(QueueingFactory $cookie) Установить экземпляр создателя куки, используемый стражем.
Dispatcher	getDispatcher() Получить экземпляр диспетчера событий.
void	setDispatcher(Dispatcher $events) Установить экземпляр диспетчера событий.
Session	getSession() Получить хранилище сессий, используемое стражем.
Authenticatable\|null	getUser() Возвращает текущего кэшированного пользователя.
Request	getRequest() Получить текущий экземпляр запроса.
$this	setRequest(Request $request) Установить текущий экземпляр запроса.
Timebox	getTimebox() Получить экземпляр timebox, используемый стражем.

Подробности

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

$this forgetUser()

Забыть текущего пользователя.

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

$this

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 void flushMacros()

Очистить существующие макросы.

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

void

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

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

Параметры

string	$method
array	$parameters

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

mixed

Исключения

BadMethodCallException

mixed __call(string $method, array $parameters)

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

Параметры

string	$method
array	$parameters

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

mixed

Исключения

BadMethodCallException

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

Создать новый страж аутентификации.

Параметры

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

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

void

Authenticatable|null user()

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

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

Authenticatable|null

protected mixed userFromRecaller(Recaller $recaller)

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

Параметры

Recaller

$recaller

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

mixed

protected Recaller|null recaller()

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

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

Recaller|null

bool once(array $credentials = [])

Войти в систему пользователя в приложение без сеансов или файлов cookie.

Параметры

array

$credentials

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

bool

Authenticatable|bool onceUsingId(mixed $id)

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

Параметры

mixed

$id

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

Authenticatable|bool

bool validate(array $credentials = [])

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

Параметры

array

$credentials

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

bool

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

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

Параметры

string	$field
array	$extraConditions

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

Response|null

Исключения

UnauthorizedHttpException

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

Выполнение попытки входа в HTTP Basic без состояния.

Параметры

string	$field
array	$extraConditions

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

Response|null

Исключения

UnauthorizedHttpException

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

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

Parameters

Запрос	$request
строка	$field
массив	$extraConditions

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

bool

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

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

Parameters

Запрос	$request
строка	$field

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

массив

protected void failedBasicResponse()

Получить ответ для базовой аутентификации.

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

void

Исключения

UnauthorizedHttpException

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

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

Parameters

массив	$credentials
bool	$remember

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

bool

bool attemptWhen(array $credentials = [], array|callable|null $callbacks = null, bool $remember = false)

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

Parameters

массив	$credentials
массив\|вызываемый объект\|null	$callbacks
bool	$remember

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

bool

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

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

Parameters

смешанный тип	$user
массив	$credentials

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

bool

protected bool shouldLogin(array|callable|null $callbacks, Authenticatable $user)

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

Parameters

массив\|вызываемый объект\|null	$callbacks
Authenticatable	$user

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

bool

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

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

Parameters

смешанный тип	$id
bool	$remember

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

Authenticatable|bool

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

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

Parameters

Authenticatable	$user
bool	$remember

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

void

protected void updateSession(string $id)

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

Parameters

строка

$id

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

void

protected void ensureRememberTokenIsSet(Authenticatable $user)

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

Parameters

Authenticatable

$user

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

void

protected void queueRecallerCookie(Authenticatable $user)

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

Parameters

Authenticatable

$user

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

void

protected Cookie createRecaller(string $value)

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

Parameters

строка

$value

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

void logout()

Выйти из системы.

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

void

void logoutCurrentDevice()

Выйти из системы только с текущего устройства.

Этот метод не меняет токен «запомнить меня».

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

void

protected void clearUserDataFromStorage()

Удалить данные пользователя из сессии и файлов cookie.

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

void

protected void cycleRememberToken(Authenticatable $user)

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

Parameters

Authenticatable

$user

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

void

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

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

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

Parameters

строка	$password
строка	$attribute

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

Authenticatable|null

Исключения

AuthenticationException

protected Authenticatable|null rehashUserPassword(string $password, string $attribute)

Перехешировать пароль текущего пользователя.

Parameters

string	$password
string	$attribute

Return Value

Authenticatable|null

Exceptions

InvalidArgumentException

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 void fireValidatedEvent(Authenticatable $user)

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

Parameters

Authenticatable

$user

Return Value

void

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

protected int getRememberDuration()

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

Return Value

int

$this setRememberDuration(int $minutes)

Установить количество минут, в течение которых куки «запомнить меня» должен быть действителен.

Parameters

int

$minutes

Return Value

$this

QueueingFactory getCookieJar()

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

Return Value

QueueingFactory

Exceptions

RuntimeException

void setCookieJar(QueueingFactory $cookie)

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

Parameters

QueueingFactory

$cookie

Return Value

void

Dispatcher getDispatcher()

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

Return Value

Dispatcher

void setDispatcher(Dispatcher $events)

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

Parameters

Dispatcher

$events

Return Value

void

Сессия getSession()

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

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

Сессия

Авторизуемый|null getUser()

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

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

Авторизуемый|null

Запрос getRequest()

Получить текущую инстанцию запроса.

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

Запрос

$this setRequest(Request $request)

Установить текущую инстанцию запроса.

Параметры

Запрос

$request

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

$this

Блок времени getTimebox()

Получить инстанцию блока времени, используемого стражем.

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

Блок времени

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