SessionGuard

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

Свойства

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

Свойства

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) Установить текущего пользователя.
static void	macro(string $name, callable $macro) Зарегистрировать пользовательское макро.	from Macroable
static bool	hasMacro(string $name) Проверить, зарегистрировано ли макро.	from Macroable
static mixed	__callStatic(string $method, array $parameters) Динамически обработать вызовы класса.	from 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.
Response	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 jar.
Cookie	createRecaller(string $value) Создать куки "запомнить меня" для данного идентификатора.
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() Получить имя cookie, используемого для хранения "recaller".
bool	viaRemember() Определить, был ли пользователь аутентифицирован через cookie "запомнить меня".
QueueingFactory	getCookieJar() Получить экземпляр создателя cookie, используемый стражем.
void	setCookieJar(QueueingFactory $cookie) Установить экземпляр создателя cookie, используемый стражем.
Dispatcher	getDispatcher() Получить экземпляр диспетчера событий.

void	setDispatcher(Dispatcher $events) Установить экземпляр диспетчера событий.
Store	getSession() Получить хранилище сессии, используемое стражем.
UserProvider	getProvider() Получить поставщика пользователей, используемого стражем.
void	setProvider(UserProvider $provider) Установить поставщика пользователей, используемого стражем.
Authenticatable\|null	getUser() Возвратить текущего кэшированного пользователя.
Request	getRequest() Получить текущий экземпляр запроса.
$this	setRequest(Request $request) Установить текущий экземпляр запроса.

Подробности

Authenticatable authenticate()

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

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

Authenticatable

Исключения

AuthenticationException

bool check()

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

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

bool

bool guest()

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

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

bool

int|null id()

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

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

int|null

void setUser(Authenticatable $user)

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

Параметры

Authenticatable

$user

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

void

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

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

Параметры

string	$name
callable	$macro

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

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
строка	$field

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

массив

protected Response failedBasicResponse()

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

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

Ответ

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

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

Параметры

массив	$credentials
логическое	$remember

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

логическое

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

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

Параметры

смешанный тип	$user
массив	$credentials

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

логическое

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

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

Параметры

смешанный тип	$id
логическое	$remember

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

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 в cookie-хранилище.

Parameters

Authenticatable

$user

Return Value

void

protected Cookie createRecaller(string $value)

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

Параметры

string

$value

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

void logout()

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

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

void

protected void clearUserDataFromStorage()

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

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

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

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

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