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	Указывает, был ли пользователь аутентифицирован с помощью куки-файла recaller.
protected Session	$session	Сессия, используемая стражем.
protected QueueingFactory	$cookie	Сервис создания куки-файлов Illuminate.
protected Request	$request	Экземпляр запроса.
protected Dispatcher	$events	Экземпляр диспетчера событий.
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 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) Создать новый охранник аутентификации.
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	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) Вызвать событие попытки с переданными аргументами.
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() Определить, был ли пользователь авторизован через куки «запомнить меня».
QueueingFactory	getCookieJar() Получить экземпляр создателя куки, используемый стражем.
void	setCookieJar(QueueingFactory $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)

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

Parameters

string

$name

Return Value

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

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

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

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)

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

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

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

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)

Вызывает событие 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()

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

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

string

bool viaRemember()

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

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

bool

QueueingFactory getCookieJar()

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

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

QueueingFactory

Исключения

RuntimeException

void setCookieJar(QueueingFactory $cookie)

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

Параметры

QueueingFactory

$cookie

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

void

Dispatcher getDispatcher()

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

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

Dispatcher

void setDispatcher(Dispatcher $events)

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

Параметры

Dispatcher

$events

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

void

Session getSession()

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

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

Session

Authenticatable|null getUser()

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

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

Authenticatable|null

Request getRequest()

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

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

Request

$this setRequest(Request $request)

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

Параметры

Request

$request

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

$this

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