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	Указывает, был ли пользователь аутентифицирован с помощью куки-файла 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() Получить 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) Авторизовать указанный 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) Определение, должен ли пользователь войти, выполнив заданные обратные вызовы.
Authenticatable\|bool	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) Создать куки "запомнить меня" для данного идентификатора.
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, используемый стражем.

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

void setUser(Authenticatable $user)

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

Parameters

Authenticatable

$user

Return Value

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)

Войти в систему пользователя с заданным 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 login.

Параметры

string	$field
array	$extraConditions

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

Response|null

Исключения

UnauthorizedHttpException

END_OF_DOCUMENT_MARKER

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

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

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

Parameters

mixed	$id
bool	$remember

Return Value

Authenticatable|bool

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)

Поместить cookie recaller в хранилище cookie.

Parameters

Authenticatable

$user

Return Value

void

protected Cookie createRecaller(string $value)

Создать cookie "запомнить меня" для данного ID.

Parameters

string

$value

Return Value

void logout()

Выйти из приложения.

Return Value

void

void logoutCurrentDevice()

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

Этот метод не циклирует токен "запомнить меня".

Return Value

void

protected void clearUserDataFromStorage()

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

Return Value

void

protected void cycleRememberToken(Authenticatable $user)

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

Parameters

Authenticatable

$user

Return Value

void

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

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

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

Parameters

string	$password
string	$attribute

Return Value

Authenticatable|null

Exceptions

AuthenticationException

END_OF_DOCUMENT_MARKER

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/10.x/Illuminate/Auth/SessionGuard.html