SessionGuard

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

Свойства

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

Свойства

protected Authenticatable	$user	Текущий аутентифицированный пользователь.	из GuardHelpers
protected UserProvider	$provider	Реализация поставщика пользователей.	из GuardHelpers
protected string	$name	Имя стража. Обычно "session".
protected Authenticatable	$lastAttempted	Пользователь, которого мы пытались получить последним.
protected bool	$viaRemember	Указывает, был ли пользователь аутентифицирован с помощью куки-файла запоминания.
protected SessionInterface	$session	Сессия, используемая стражем.
protected QueueingFactory	$cookie	Услуга создания куки-файлов Illuminate.
protected Request	$request	Экземпляр запроса.
protected Dispatcher	$events	Экземпляр диспетчера событий.
protected bool	$loggedOut	Указывает, был ли вызван метод выхода.
protected bool	$tokenRetrievalAttempted	Указывает, была ли предпринята попытка получения пользователя по токену.

Методы

Authenticatable	authenticate() Определить, авторизован ли текущий пользователь.	from GuardHelpers
bool	check() Определить, авторизован ли текущий пользователь.	from GuardHelpers
bool	guest() Определить, является ли текущий пользователь гостем.	from GuardHelpers
int\|null	id() Получить ID текущего авторизованного пользователя.
void	setUser(Authenticatable $user) Установить текущего пользователя.
void	__construct(string $name, UserProvider $provider, SessionInterface $session, Request $request = null) Создать новый объект аутентификационного провайдера.
Authenticatable\|null	user() Получить текущего авторизованного пользователя.
mixed	getUserByRecaller(string $recaller) Извлечь пользователя из хранилища по его идентификатору.
string\|null	getRecaller() Получить расшифрованный куки-файл recaller для запроса.
string\|null	getRecallerId() Получить ID пользователя из куки-файла recaller.
bool	validRecaller(mixed $recaller) Определить, имеет ли куки-файл recaller допустимый формат.
bool	once(array $credentials = []) Войти в систему пользователю без использования сессий или куки-файлов.
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	getBasicCredentials(Request $request, string $field) Получить массив учетных данных для HTTP Basic запроса.
Response	getBasicResponse() Получить ответ для базовой аутентификации.
bool	attempt(array $credentials = [], bool $remember = false, bool $login = true) Попытка аутентификации пользователя с использованием предоставленных учетных данных.
bool	hasValidCredentials(mixed $user, array $credentials) Определить, соответствует ли пользователь предоставленным учетным данным.
void	fireAttemptEvent(array $credentials, bool $remember, bool $login) Вызвать событие попытки аутентификации с заданными параметрами.
void	fireFailedEvent(Authenticatable\|null $user, array $credentials) Вызвать событие неудачной попытки аутентификации с предоставленными аргументами.
void	attempting(mixed $callback) Зарегистрировать обработчик событий попытки аутентификации.
void	login(Authenticatable $user, bool $remember = false) Войти в систему пользователю.
void	fireLoginEvent(Authenticatable $user, bool $remember = false) Вызвать событие входа в систему, если диспетчер установлен.
void	fireAuthenticatedEvent(Authenticatable $user) Вызвать событие аутентификации, если диспетчер установлен.
void	updateSession(string $id) Обновить сессию с заданным ID.
Authenticatable	loginUsingId(mixed $id, bool $remember = false) Войти в систему с помощью заданного ID пользователя.
bool	onceUsingId(mixed $id) Войти в систему с помощью заданного ID пользователя без использования сессий или куки-файлов.
void	queueRecallerCookie(Authenticatable $user) Добавить куки-файл recaller в хранилище куки-файлов.
Cookie	createRecaller(string $value) Создать куки-файл «запомнить меня» для заданного ID.
void	logout() Выйти из системы пользователя.
void	clearUserDataFromStorage() Удалить данные пользователя из сессии и куки-файлов.
void	refreshRememberToken(Authenticatable $user) Обновить токен «запомнить меня» для пользователя.
void	createRememberTokenIfDoesntExist(Authenticatable $user) Создать новый токен «запомнить меня» для пользователя, если он еще не существует.
QueueingFactory	getCookieJar() Получить экземпляр создателя куки-файлов, используемый провайдером.
void	setCookieJar(QueueingFactory $cookie) Установить экземпляр создателя куки-файлов, используемый провайдером.
Dispatcher	getDispatcher() Получить экземпляр диспетчера событий.
void	setDispatcher(Dispatcher $events) Установить экземпляр диспетчера событий.

Хранилище	getSession() Получить хранилище сессии, используемое стражем.
Поставщик пользователей	getProvider() Получить поставщика пользователей, используемого стражем.
void	setProvider(Поставщик пользователей $provider) Установить поставщика пользователей, используемого стражем.
Авторизуемый\|null	getUser() Возвращает текущего кэшированного пользователя.
Запрос	getRequest() Получить текущий экземпляр запроса.
$this	setRequest(Request $request) Установить текущий экземпляр запроса.
Авторизуемый	getLastAttempted() Получить последнего пользователя, для которого пытались выполнить аутентификацию.
строка	getName() Получить уникальный идентификатор для значения сессии аутентификации.
строка	getRecallerName() Получить имя cookie, используемого для хранения "recaller".
логическое	viaRemember() Определить, был ли пользователь аутентифицирован с помощью cookie "запомнить меня".

Подробности

Авторизуемый authenticate()

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

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

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

Исключения

ИсключениеАутентификации

логическое check()

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

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

логическое

логическое guest()

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

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

логическое

целое число|null id()

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

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

целое число|null

void setUser(Авторизуемый $user)

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

Параметры

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

$user

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

void

void __construct(string $name, Поставщик пользователей $provider, SessionInterface $session, Request $request = null)

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

Параметры

строка	$name
Поставщик пользователей	$provider
SessionInterface	$session
Запрос	$request

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

void

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

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

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

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

protected смешанный тип getUserByRecaller(string $recaller)

Извлечь пользователя из репозитория по его ID recaller.

Параметры

строка

$recaller

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

смешанный тип

protected строка|null getRecaller()

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

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

строка|null

protected строка|null getRecallerId()

Получить ID пользователя из cookie recaller.

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

строка|null

protected логическое validRecaller(смешанный тип $recaller)

Определить, находится ли cookie recaller в корректном формате.

Параметры

смешанный тип

$recaller

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

логическое

логическое once(array $credentials = [])

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

Параметры

массив

$credentials

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

логическое

логическое validate(array $credentials = [])

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

Параметры

массив

$credentials

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

логическое

Ответ|null basic(string $field = 'email', array $extraConditions = [])

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

Параметры

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

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

Ответ|null

Ответ|null onceBasic(string $field = 'email', array $extraConditions = [])

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

Параметры

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

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

Ответ|null

protected логическое attemptBasic(Request $request, string $field, array $extraConditions = [])

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

Параметры

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

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

логическое

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

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

Parameters

Request	$request
string	$field

Return Value

array

protected Response getBasicResponse()

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

Return Value

Response

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

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

Parameters

array	$credentials
bool	$remember
bool	$login

Return Value

bool

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

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

Parameters

mixed	$user
array	$credentials

Return Value

bool

protected void fireAttemptEvent(array $credentials, bool $remember, bool $login)

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

Parameters

array	$credentials
bool	$remember
bool	$login

Return Value

void

protected void fireFailedEvent(Authenticatable|null $user, array $credentials)

Вызвать событие неудачной попытки аутентификации с указанными аргументами.

Parameters

Authenticatable\|null	$user
array	$credentials

Return Value

void

void attempting(mixed $callback)

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

Parameters

mixed

$callback

Return Value

void

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

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

Parameters

Authenticatable	$user
bool	$remember

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 updateSession(string $id)

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

Parameters

string

$id

Return Value

void

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

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

Parameters

mixed	$id
bool	$remember

Return Value

Authenticatable

bool onceUsingId(mixed $id)

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

Parameters

mixed

$id

Return Value

bool

protected void queueRecallerCookie(Authenticatable $user)

Поместить файл cookie "запоминать меня" в хранилище.

Parameters

Authenticatable

$user

Return Value

void

protected Cookie createRecaller(string $value)

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

Parameters

string

$value

Return Value

void logout()

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

Return Value

void

protected void clearUserDataFromStorage()

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

Return Value

void

protected void refreshRememberToken(Authenticatable $user)

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

Parameters

Authenticatable

$user

Return Value

void

protected void createRememberTokenIfDoesntExist(Authenticatable $user)

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

Параметры

Authenticatable

$user

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

void

QueueingFactory getCookieJar()

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

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

QueueingFactory

Исключения

RuntimeException

void setCookieJar(QueueingFactory $cookie)

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

Параметры

QueueingFactory

$cookie

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

void

Dispatcher getDispatcher()

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

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

Dispatcher

void setDispatcher(Dispatcher $events)

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

Параметры

Dispatcher

$events

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

void

Store getSession()

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

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

Store

UserProvider getProvider()

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

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

UserProvider

void setProvider(UserProvider $provider)

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

Параметры

UserProvider

$provider

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

void

Authenticatable|null getUser()

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

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

Authenticatable|null

Request getRequest()

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

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

Request

$this setRequest(Request $request)

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

Параметры

Request

$request

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

$this

Authenticatable getLastAttempted()

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

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

Authenticatable

string getName()

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

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

string

string getRecallerName()

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

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

string

bool viaRemember()

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

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

bool

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