SessionGuard

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

Свойства

Эти методы, как правило, одинаковы для всех охранников.

Свойства

protected Authenticatable\|null	$user	Текущий аутентифицированный пользователь.	из GuardHelpers
protected UserProvider	$provider	Реализация поставщика пользователей.	из GuardHelpers
static protected array	$macros	Зарегистрированные строковые макросы.	из Macroable
string	$name	Имя охранника. Обычно "web".
protected Authenticatable	$lastAttempted	Пользователь, которого мы в последний раз пытались получить.
protected bool	$viaRemember	Указывает, был ли пользователь аутентифицирован с помощью куки-файла запоминания.
protected int	$rememberDuration	Количество минут, в течение которых должен действовать куки-файл "запомнить меня".
protected Session	$session	Сессия, используемая охранником.
protected QueueingFactory	$cookie	Сервис создания куки-файлов Illuminate.
protected Request	$request	Экземпляр запроса.
protected Dispatcher	$events	Экземпляр диспетчера событий.
protected Timebox	$timebox	Экземпляр Timebox.
protected bool	$rehashOnLogin	Указывает, следует ли перехешировать пароли при входе в систему, если это необходимо.
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 текущего авторизованного пользователя.
$this	setUser(Authenticatable $user) Установить текущего пользователя.
$this	forgetUser() Забыть текущего пользователя.	from GuardHelpers
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 void	flushMacros() Очистить существующие макросы.	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\|null $request = null, Timebox\|null $timebox = null, bool $rehashOnLogin = true) Создать новый страж аутентификации.
Authenticatable\|null	user() Получить текущего авторизованного пользователя.
mixed	userFromRecaller(Recaller $recaller) Извлечь пользователя из репозитория по токену куки «запомнить меня».
Recaller\|null	recaller() Получить расшифрованный куки recaller для запроса.
bool	once(array $credentials = []) Войти в систему пользователю в приложении без сессий или куки.
Authenticatable\|false	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	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) Определить, должен ли пользователь войти в систему, выполняя заданные обратные вызовы.
void	rehashPasswordIfRequired(Authenticatable $user, array $credentials) Перехэшировать пароль пользователя, если это разрешено и необходимо.
Authenticatable\|false	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) Создать cookie "запомнить меня" для данного ID.
void	logout() Вывести пользователя из приложения.
void	logoutCurrentDevice() Вывести пользователя из приложения только на текущем устройстве.
void	clearUserDataFromStorage() Удалить данные пользователя из сессии и куки.
void	cycleRememberToken(Authenticatable $user) Обновить токен "запомнить меня" для пользователя.
Authenticatable\|null	logoutOtherDevices(string $password) Удалить другие сессии для текущего пользователя.
Authenticatable\|null	rehashUserPasswordForDeviceLogout(string $password) Перехешировать пароль текущего пользователя для выхода из других устройств через AuthenticateSession.
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, используемый стражем.

Details

Authenticatable authenticate()

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

Return Value

Authenticatable

Exceptions

AuthenticationException

bool hasUser()

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

Return Value

bool

bool check()

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

Return Value

bool

bool guest()

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

Return Value

bool

int|string|null id()

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

Return Value

int|string|null

$this setUser(Authenticatable $user)

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

Параметры

Authenticatable

$user

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

$this

$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|null $request = null, Timebox|null $timebox = null, bool $rehashOnLogin = true)

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

Параметры

string	$name
UserProvider	$provider
Session	$session
Request\|null	$request
Timebox\|null	$timebox
bool	$rehashOnLogin

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

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|false onceUsingId(mixed $id)

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

Параметры

mixed

$id

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

Authenticatable|false

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 без сохранения состояния.

Parameters

string	$field
array	$extraConditions

Return Value

Response|null

Exceptions

UnauthorizedHttpException

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

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

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

Parameters

array	$credentials
array\|callable\|null	$callbacks
bool	$remember

Return Value

bool

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

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

Parameters

mixed	$user
array	$credentials

Return Value

bool

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

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

Parameters

array\|callable\|null	$callbacks
Authenticatable	$user

Return Value

bool

protected void rehashPasswordIfRequired(Authenticatable $user, array $credentials)

Перехешировать пароль пользователя, если это необходимо.

Parameters

Authenticatable	$user
array	$credentials

Return Value

void

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

Авторизовать пользователя по его ID.

Parameters

mixed	$id
bool	$remember

Return Value

Authenticatable|false

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

void logoutCurrentDevice()

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

Этот метод не сбрасывает токен «запомнить меня».

Return Value

void

protected void clearUserDataFromStorage()

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

Return Value

void

protected void cycleRememberToken(Authenticatable $user)

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

Parameters

Authenticatable

$user

Return Value

void

Authenticatable|null logoutOtherDevices(string $password)

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

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

Parameters

string

$password

Return Value

Authenticatable|null

Exceptions

AuthenticationException

protected Authenticatable|null rehashUserPasswordForDeviceLogout(string $password)

Перехэшировать пароль текущего пользователя для выхода из других устройств через AuthenticateSession.

Parameters

string

$password

Return Value

Authenticatable|null

Exceptions

InvalidArgumentException

void attempting(mixed $callback)

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

Parameters

mixed

$callback

Return Value

void

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

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

Parameters

array	$credentials
bool	$remember

Return Value

void

protected void fireValidatedEvent(Authenticatable $user)

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

Parameters

Authenticatable

$user

Return Value

void

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

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

Parameters

Authenticatable	$user
bool	$remember

Return Value

void

protected void fireAuthenticatedEvent(Authenticatable $user)

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

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

Получить имя cookie, используемого для хранения "recaller".

Return Value

string

bool viaRemember()

Определить, был ли пользователь аутентифицирован с помощью cookie "запомнить меня".

Return Value

bool

protected int getRememberDuration()

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

Return Value

int

$this setRememberDuration(int $minutes)

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

Parameters

int

$minutes

Return Value

$this

QueueingFactory getCookieJar()

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

Return Value

QueueingFactory

Exceptions

RuntimeException

void setCookieJar(ОчередьФэйктори $cookie)

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

Параметры

ОчередьФэйктори

$cookie

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

void

Диспечер getDispatcher()

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

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

Диспечер

void setDispatcher(Диспечер $events)

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

Параметры

Диспечер

$events

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

void

Сессия getSession()

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

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

Сессия

Аутентифицируемый|null getUser()

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

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

Аутентифицируемый|null

Запрос getRequest()

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

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

Запрос

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

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

Параметры

Запрос

$request

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

$this

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

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

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

БлокВремени

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