SessionGuard

класс SessionGuard реализует 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	Указывает, был ли пользователь аутентифицирован с помощью куки-файла запоминания.
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\|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) Зарегистрировать пользовательскую макрокоманду.	из Macroable
static void	mixin(object $mixin) Смешать другой объект в класс.	из Macroable
static bool	hasMacro(string $name) Проверяет, зарегистрирована ли макрокоманда.	из 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) Создать новый объект аутентификации.
Authenticatable\|null	user() Получить текущего аутентифицированного пользователя.
mixed	userFromRecaller(Recaller $recaller) Получить пользователя из репозитория по токену куки "запомнить меня".

Recaller\|null	recaller() Получить расшифрованный куки recaller для запроса.
bool	once(array $credentials = []) Выполнить вход пользователя в приложение без сессий или куки.
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) Войти в систему с указанным идентификатором пользователя.
void	login(Authenticatable $user, bool $remember = false) Авторизовать пользователя в системе.
void	updateSession(string $id) Обновить сессию с указанным идентификатором.
void	ensureRememberTokenIsSet(Authenticatable $user) Создать новый токен "запомнить меня", если он ещё не существует для пользователя.
void	queueRecallerCookie(Authenticatable $user) Отправить куки "запомнить меня" в хранилище куки.
Cookie	createRecaller(string $value) Создать куки "запомнить меня" для данного ID.
void	logout() Выйти из системы.
void	clearUserDataFromStorage() Удалить данные пользователя из сессии и куков.
void	cycleRememberToken(Authenticatable $user) Обновить токен "запомнить меня" для пользователя.

null\|bool	logoutOtherDevices(string $password, string $attribute = 'password') Отключить другие сессии для текущего пользователя.
void	attempting(mixed $callback) Зарегистрировать слушателя события попытки аутентификации.
void	fireAttemptEvent(array $credentials, bool $remember = false) Вызвать событие попытки с аргументами.
void	fireLoginEvent(Authenticatable $user, bool $remember = false) Вызвать событие входа в систему, если диспетчер установлен.
void	fireAuthenticatedEvent(Authenticatable $user) Вызвать событие аутентификации, если диспетчер установлен.
void	fireFailedEvent(Authenticatable\|null $user, array $credentials) Вызвать событие неудачной попытки аутентификации с заданными аргументами.
Authenticatable	getLastAttempted() Получить последнего пользователя, для которого была попытка аутентификации.
string	getName() Получить уникальный идентификатор для значения сессии аутентификации.
string	getRecallerName() Получить имя cookie, используемой для хранения «рекаллера».

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

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

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

int|null

void setUser(Authenticatable $user)

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

Параметры

Authenticatable

$user

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

void

Провайдер пользователей getProvider()

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

Значение возврата

Провайдер пользователей

void setProvider(Провайдер пользователей $provider)

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

Параметры

Провайдер пользователей

$provider

Значение возврата

void

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

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

Параметры

string	$name
object\|callable	$macro

Значение возврата

void

static void mixin(object $mixin)

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

Параметры

object

$mixin

Значение возврата

void

Исключения

ReflectionException

static bool hasMacro(string $name)

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

Параметры

string

$name

Значение возврата

bool

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)

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

Параметры

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

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

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 = [])

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

Параметры

array

$credentials

Значение возвращаемого значения

bool

bool onceUsingId(mixed $id)

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

Параметры

mixed

$id

Значение возвращаемого значения

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

Response|null onceBasic(string $field = 'email', array $extraConditions = [])

Выполнить попытку одноразового HTTP Basic входа.

Параметры

string	$field
array	$extraConditions

Значение возврата

Response|null

protected bool attemptBasic(Request $request, string $field, array $extraConditions = [])

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

Параметры

Request	$request
string	$field
array	$extraConditions

Значение возврата

bool

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

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

Параметры

Request	$request
string	$field

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

array

protected void failedBasicResponse()

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

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

void

Исключения

UnauthorizedHttpException

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

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

Параметры

array	$credentials
bool	$remember

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

bool

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

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

Параметры

mixed	$user
array	$credentials

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

bool

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

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

Параметры

mixed	$id
bool	$remember

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

Authenticatable

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

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

Параметры

Authenticatable	$user
bool	$remember

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

void

protected void updateSession(string $id)

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

Параметры

string

$id

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

void

protected void ensureRememberTokenIsSet(Authenticatable $user)

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

Параметры

Authenticatable

$user

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

void

protected void queueRecallerCookie(Authenticatable $user)

Добавить куки recaller в хранилище.

Параметры

Authenticatable

$user

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

void

protected Cookie createRecaller(string $value)

Создать куки "запомнить меня" для заданного идентификатора.

Параметры

string

$value

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

void logout()

Вывести пользователя из приложения.

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

void

protected void clearUserDataFromStorage()

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

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

void

protected void cycleRememberToken(Authenticatable $user)

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

Параметры

Authenticatable

$user

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

void

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

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

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

Параметры

string	$password
string	$attribute

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

null|bool

void attempting(mixed $callback)

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

Параметры

mixed

$callback

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

void

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

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

Параметры

array	$credentials
bool	$remember

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

void

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

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

Параметры

Authenticatable	$user
bool	$remember

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

void

protected void fireAuthenticatedEvent(Authenticatable $user)

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

Параметры

Authenticatable

$user

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

void

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

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

Параметры

Authenticatable\|null	$user
array	$credentials

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

void

Authenticatable getLastAttempted()

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

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

Authenticatable

string getName()

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

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

string

string getRecallerName()

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

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

string

bool viaRemember()

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

Значение возврата

bool

QueueingFactory getCookieJar()

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

Значение возврата

QueueingFactory

Исключения

RuntimeException

void setCookieJar(QueueingFactory $cookie)

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

Параметры

QueueingFactory

$cookie

Значение возврата

void

Dispatcher getDispatcher()

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

Значение возврата

Dispatcher

void setDispatcher(Dispatcher $events)

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

Параметры

Dispatcher

$events

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

void

Сессия getSession()

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

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

Сессия

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

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

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

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

Запрос getRequest()

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

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

Запрос

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

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

Параметры

Запрос

$request

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

$this

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