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	Указывает, был ли пользователь аутентифицирован с помощью куки-файла запоминания.
protected Session	$session	Сессия, используемая сторожем.
protected QueueingFactory	$cookie	Сервис создания куки-файлов Illuminate.
protected Request	$request	Экземпляр запроса.
protected Dispatcher	$events	Экземпляр диспетчера событий.
protected bool	$loggedOut	Указывает, был ли вызван метод выхода.
protected bool	$recallAttempted	Указывает, была ли предпринята попытка получения пользователя по токену.

Методы

Authenticatable	authenticate() Определить, является ли текущий пользователь аутентифицированным.	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) Зарегистрировать пользовательское макро.	from Macroable

static void	mixin(object $mixin) Смешать другой объект в класс.	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 = []) Выполнить вход пользователя в приложение без сессий или куки.
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) Обновить токен "запомнить меня" для пользователя.

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() Получить имя куки, используемого для хранения "recaller".
bool	viaRemember() Определить, был ли пользователь авторизован с помощью куки "запомнить меня".

Создатель очереди файлов cookie	getCookieJar() Получить экземпляр создателя файлов cookie, используемый стражем.
void	setCookieJar(Создатель очереди файлов cookie $cookie) Установить экземпляр создателя файлов cookie, используемый стражем.
Диспечер событий	getDispatcher() Получить экземпляр диспечера событий.
void	setDispatcher(Диспечер событий $events) Установить экземпляр диспечера событий.
Сессия	getSession() Получить хранилище сеанса, используемое стражем.
Проверяемый\|null	getUser() Возвратить текущего кэшированного пользователя.
Запрос	getRequest() Получить текущий экземпляр запроса.
$this	setRequest(Request $request) Установить текущий экземпляр запроса.

Подробности

Authenticatable authenticate()

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

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

Authenticatable

Исключения

AuthenticationException

bool check()

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

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

bool

bool guest()

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

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

bool

int|null id()

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

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

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

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

Параметры

object

$mixin

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

void

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

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

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

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

bool

Создатель очереди файлов cookie getCookieJar()

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

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

Создатель очереди файлов cookie

Исключения

RuntimeException

void setCookieJar(Создатель очереди файлов cookie $cookie)

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

Параметры

Создатель очереди файлов cookie

$cookie

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

void

Диспетчер событий getDispatcher()

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

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

Диспетчер событий

void setDispatcher(Диспетчер событий $events)

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

Параметры

Диспетчер событий

$events

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

void

Сессия. getSession()

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

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

Сессия.

Проверяемый|null getUser()

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

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

Проверяемый|null

Запрос getRequest()

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

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

Запрос

$this setRequest(Request $request)

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

Параметры

Запрос

$request

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

$this

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