Guard

class Guard implements Guard (View source)

Свойства

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

Методы

void	__construct(UserProvider $provider, SessionInterface $session, Request $request = null) Создать новую стражу аутентификации.
bool	check() Определить, является ли текущий пользователь аутентифицированным.
bool	guest() Определить, является ли текущий пользователь гостем.
Authenticatable\|null	user() Получить текущего аутентифицированного пользователя.
int\|null	id() Получить ID текущего аутентифицированного пользователя.
mixed	getUserByRecaller(string $recaller) Извлечь пользователя из репозитория по его идентификатору recaller.
string\|null	getRecaller() Получить расшифрованный куки recaller для запроса.
string\|null	getRecallerId() Получить идентификатор пользователя из куки recaller.
bool	validRecaller(string $recaller) Определить, соответствует ли куки recaller валидному формату.
bool	once(array $credentials = []) Авторизовать пользователя в приложении без сессий или куки.
bool	validate(array $credentials = []) Проверить учетные данные пользователя.
Response\|null	basic(string $field = 'email') Попытка аутентификации с использованием HTTP Basic Auth.
Response\|null	onceBasic(string $field = 'email') Выполнить попытку бесстаточной аутентификации HTTP Basic.
bool	attemptBasic(Request $request, string $field) Попытка аутентификации с использованием базовой аутентификации.
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	attempting(mixed $callback) Зарегистрировать обработчик событий попытки аутентификации.
void	login(Authenticatable $user, bool $remember = false) Авторизовать пользователя в приложении.
void	fireLoginEvent(Authenticatable $user, bool $remember = false) Вызвать событие входа, если диспетчер установлен.
void	updateSession(string $id) Обновить сессию с указанным ID.
Authenticatable	loginUsingId(mixed $id, bool $remember = false) Авторизовать пользователя с указанным ID в приложении.
bool	onceUsingId(mixed $id) Авторизовать пользователя с указанным ID в приложении без сессий или куки.
void	queueRecallerCookie(Authenticatable $user) Добавить куки recaller в cookie-хранилище.
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) Установить экземпляр диспетчера событий.
Store	getSession() Получить хранилище сессий, используемое стражей.
UserProvider	getProvider() Получить поставщика пользователей, используемого стражей.
void	setProvider(UserProvider $provider) Установить поставщика пользователей, используемого стражей.
Authenticatable\|null	getUser() Возвратить текущего кэшированного пользователя.
void	setUser(Authenticatable $user) Установить текущего пользователя.
Request	getRequest() Получить текущий экземпляр запроса.
$this	setRequest(Request $request) Установить текущий экземпляр запроса.

Authenticatable	getLastAttempted() Получить последнюю попытку аутентификации пользователя.
строка	getName() Получить уникальный идентификатор для значения сессии аутентификации.
строка	getRecallerName() Получить имя куки, используемой для хранения "recaller".
логическое значение	viaRemember() Определить, был ли пользователь аутентифицирован через куки "запомнить меня".

Подробности

void __construct(UserProvider $provider, SessionInterface $session, Request $request = null)

Создать новый объект аутентификации.

Параметры

UserProvider	$provider
SessionInterface	$session
Request	$request

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

void

логическое значение check()

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

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

логическое значение

логическое значение guest()

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

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

логическое значение

Authenticatable|null user()

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

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

Authenticatable|null

int|null id()

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

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

int|null

protected mixed getUserByRecaller(string $recaller)

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

Параметры

строка

$recaller

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

mixed

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

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

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

строка|null

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

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

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

строка|null

protected логическое значение validRecaller(string $recaller)

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

Параметры

строка

$recaller

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

логическое значение

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

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

Параметры

массив

$credentials

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

логическое значение

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

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

Параметры

массив

$credentials

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

логическое значение

Response|null basic(string $field = 'email')

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

Параметры

строка

$field

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

Response|null

Response|null onceBasic(string $field = 'email')

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

Параметры

строка

$field

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

Response|null

protected логическое значение attemptBasic(Request $request, string $field)

Попытка аутентификации с помощью basic авторизации.

Параметры

Request	$request
строка	$field

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

логическое значение

protected массив getBasicCredentials(Request $request, string $field)

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

Параметры

Request	$request
строка	$field

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

массив

protected Response getBasicResponse()

Получить ответ для basic авторизации.

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

Response

логическое значение attempt(array $credentials = [], bool $remember = false, bool $login = true)

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

Параметры

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

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

логическое значение

protected логическое значение hasValidCredentials(mixed $user, array $credentials)

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

Параметры

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

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

логическое значение

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

Сгенерировать событие попытки аутентификации с предоставленными аргументами.

Параметры

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

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

void

void attempting(mixed $callback)

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

Параметры

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

$callback

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

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

Обновить сессию с заданным идентификатором.

Parameters

string

$id

Return Value

void

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

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

Parameters

mixed	$id
bool	$remember

Return Value

Authenticatable

bool onceUsingId(mixed $id)

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

Parameters

mixed

$id

Return Value

bool

protected void queueRecallerCookie(Authenticatable $user)

Поместить куки подтверждения в очередь.

Parameters

Authenticatable

$user

Return Value

void

protected Cookie createRecaller(string $value)

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

Parameters

string

$value

Return Value

void logout()

Выйти из приложения.

Return Value

void

protected void clearUserDataFromStorage()

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

Return Value

void

protected void refreshRememberToken(Authenticatable $user)

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

Parameters

Authenticatable

$user

Return Value

void

protected void createRememberTokenIfDoesntExist(Authenticatable $user)

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

Parameters

Authenticatable

$user

Return Value

void

QueueingFactory getCookieJar()

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

Return Value

QueueingFactory

Exceptions

RuntimeException

void setCookieJar(QueueingFactory $cookie)

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

Parameters

QueueingFactory

$cookie

Return Value

void

Dispatcher getDispatcher()

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

Return Value

Dispatcher

void setDispatcher(Dispatcher $events)

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

Parameters

Dispatcher

$events

Return Value

void

Store getSession()

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

Return Value

Store

UserProvider getProvider()

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

Return Value

UserProvider

void setProvider(UserProvider $provider)

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

Parameters

UserProvider

$provider

Return Value

void

Authenticatable|null getUser()

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

Return Value

Authenticatable|null

void setUser(Authenticatable $user)

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

Параметры

Authenticatable

$user

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

void

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.5/Illuminate/Auth/Guard.html