SessionGuard

class SessionGuard implements StatefulGuard, SupportsBasicAuth (View source)

Свойства

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

Свойства

protected Authenticatable	$user	Текущий аутентифицированный пользователь.	из GuardHelpers
protected UserProvider	$provider	Реализация поставщика пользователей.	из GuardHelpers
static protected array	$macros	Зарегистрированные строковые макросы.	из Macroable
protected 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	$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 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 $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 $callbacks = null, false $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) Создать куки «запомнить меня» для данного ID.

void	logout() Выйти из приложения пользователя.
void	logoutCurrentDevice() Выйти из приложения пользователя только с текущего устройства.
void	clearUserDataFromStorage() Удалить данные пользователя из сессии и cookie.
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() Получить имя cookie, используемой для хранения «recaller».
bool	viaRemember() Определить, был ли пользователь аутентифицирован с помощью cookie «запомнить меня».
int	getRememberDuration() Получить количество минут, в течение которых cookie «запомнить меня» должна быть действительной.
$this	setRememberDuration(int $minutes) Установить количество минут, в течение которых 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) Установить текущий экземпляр запроса.
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

UserProvider getProvider()

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

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

UserProvider

void setProvider(UserProvider $provider)

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

Parameters

UserProvider

$provider

Return Value

void

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

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

Parameters

string	$name
object\|callable	$macro

Return Value

void

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

Смешать другой объект в класс.

Parameters

object	$mixin
bool	$replace

Return Value

void

Exceptions

ReflectionException

static bool hasMacro(string $name)

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

Parameters

string

$name

Return Value

bool

static void flushMacros()

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

Return Value

void

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, Timebox $timebox = null)

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

Parameters

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

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

Authenticatable|bool onceUsingId(mixed $id)

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

Parameters

mixed

$id

Return Value

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

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

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

void

Исключения

UnauthorizedHttpException

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

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

Параметры

array	$credentials
bool	$remember

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

bool

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

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

Параметры

array	$credentials
array\|callable	$callbacks
false	$remember

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

bool

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

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

Параметры

mixed	$user
array	$credentials

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

bool

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

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

Параметры

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

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

bool

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

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

Параметры

mixed	$id
bool	$remember

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

Authenticatable|bool

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

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

Параметры

Authenticatable	$user
bool	$remember

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

void

protected void updateSession(string $id)

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

Параметры

string

$id

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

void

protected void ensureRememberTokenIsSet(Authenticatable $user)

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

Параметры

Authenticatable

$user

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

void

protected void queueRecallerCookie(Authenticatable $user)

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

Параметры

Authenticatable

$user

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

void

protected Cookie createRecaller(string $value)

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

Параметры

string

$value

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

void logout()

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

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

void

void logoutCurrentDevice()

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

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

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

void

protected void clearUserDataFromStorage()

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

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

void

protected void cycleRememberToken(Authenticatable $user)

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

Параметры

Authenticatable

$user

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

void

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

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

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

Параметры

string	$password
string	$attribute

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

Authenticatable|null

Исключения

AuthenticationException

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

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

Параметры

string	$password
string	$attribute

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

Authenticatable|null

Исключения

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

Session getSession()

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

Return Value

Session

Authenticatable|null getUser()

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

Return Value

Authenticatable|null

Request getRequest()

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

Return Value

Request

$this setRequest(Request $request)

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

Параметры

Request

$request

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

$this

Timebox getTimebox()

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

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

Timebox

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