Охрана

класс Охрана (Просмотреть исходный код)

Свойства

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

Методы

void	__construct(UserProviderInterface $provider, Store $session, Request $request = null) Создать новый объект аутентификации.
bool	check() Определить, авторизован ли текущий пользователь.
bool	guest() Определить, является ли текущий пользователь гостем.
UserInterface\|null	user() Получить текущего авторизованного пользователя.
int\|null	id() Получить ID текущего авторизованного пользователя.
mixed	getUserByRecaller(string $recaller) Получить пользователя из репозитория по его идентификатору рекаллера.
string\|null	getRecaller() Получить расшифрованный cookie рекаллера для запроса.
string	getRecallerId() Получить ID пользователя из cookie рекаллера.
bool	validRecaller(string $recaller) Определить, является ли cookie рекаллера валидным.
bool	once(array $credentials = array()) Авторизовать пользователя в приложении без сессий или cookie.
bool	validate(array $credentials = array()) Проверить учетные данные пользователя.
Response\|null	basic(string $field = 'email', Request $request = null) Попытка аутентификации с помощью HTTP Basic Auth.
Response\|null	onceBasic(string $field = 'email', Request $request = null) Выполнить бессостоятельный запрос на вход в систему с HTTP Basic.
bool	attemptBasic(Request $request, string $field) Попытка аутентификации с помощью базовой аутентификации.
array	getBasicCredentials(Request $request, string $field) Получить массив учетных данных для HTTP Basic запроса.
Response	getBasicResponse() Получить ответ для базовой аутентификации.
bool	attempt(array $credentials = array(), 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(UserInterface $user, bool $remember = false) Авторизовать пользователя в приложении.
void	updateSession(string $id) Обновить сессию с заданным ID.
UserInterface	loginUsingId(mixed $id, bool $remember = false) Авторизовать пользователя с заданным ID в приложении.
bool	onceUsingId(mixed $id) Авторизовать пользователя с заданным ID в приложении без сессий или cookie.
void	queueRecallerCookie(UserInterface $user) Добавить cookie рекаллера в cookie-контейнер.
Cookie	createRecaller(string $value) Создать cookie "запомнить меня" для данного ID.
void	logout() Выход пользователя из приложения.
void	clearUserDataFromStorage() Удалить данные пользователя из сессии и cookie.
void	refreshRememberToken(UserInterface $user) Обновить токен "запомнить меня" для пользователя.
void	createRememberTokenIfDoesntExist(UserInterface $user) Создать новый токен "запомнить меня" для пользователя, если он не существует.
CookieJar	getCookieJar() Получить экземпляр создателя cookie, используемый охранником.
void	setCookieJar(CookieJar $cookie) Установить экземпляр создателя cookie, используемый охранником.
Dispatcher	getDispatcher() Получить экземпляр диспетчера событий.
void	setDispatcher(Dispatcher $events) Установить экземпляр диспетчера событий.
Store	getSession() Получить хранилище сессий, используемое охранником.
UserProviderInterface	getProvider() Получить поставщика пользователей, используемого охранником.
void	setProvider(UserProviderInterface $provider) Установить поставщика пользователей, используемого охранником.
UserInterface\|null	getUser() Возвращает текущего кешированного пользователя приложения.
void	setUser(UserInterface $user) Установить текущего пользователя приложения.
Request	getRequest() Получить текущий экземпляр запроса.
$this	setRequest(Request $request) Установить текущий экземпляр запроса.
UserInterface	getLastAttempted() Получить последнего пользователя, для которого пытались выполнить аутентификацию.
string	getName() Получить уникальный идентификатор для значения сессии аутентификации.

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

Подробности

void __construct(UserProviderInterface $provider, Store $session, Request $request = null)

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

Параметры

UserProviderInterface	$provider
Store	$session
Request	$request

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

void

bool check()

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

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

bool

bool guest()

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

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

bool

UserInterface|null user()

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

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

UserInterface|null

int|null id()

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

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

int|null

protected mixed getUserByRecaller(string $recaller)

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

Параметры

string

$recaller

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

mixed

protected string|null getRecaller()

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

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

string|null

protected string getRecallerId()

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

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

string

protected bool validRecaller(string $recaller)

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

Параметры

string

$recaller

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

bool

bool once(array $credentials = array())

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

Параметры

array

$credentials

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

bool

bool validate(array $credentials = array())

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

Параметры

array

$credentials

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

bool

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

Попытка авторизации с помощью HTTP Basic Auth.

Параметры

string	$field
Request	$request

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

Response|null

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

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

Параметры

string	$field
Request	$request

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

Response|null

protected bool attemptBasic(Request $request, string $field)

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

Параметры

Request	$request
string	$field

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

bool

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

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

Параметры

Request	$request
string	$field

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

array

protected Response getBasicResponse()

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

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

Response

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

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

Параметры

array	$credentials
bool	$remember
bool	$login

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

bool

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

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

Параметры

mixed	$user
array	$credentials

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

bool

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

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

Параметры

array	$credentials
bool	$remember
bool	$login

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

void

void attempting(mixed $callback)

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

Параметры

mixed

$callback

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

void

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

Авторизовать пользователя в приложении.

Параметры

UserInterface	$user
bool	$remember

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

void

protected void updateSession(string $id)

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

Parameters

string

$id

Return Value

void

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

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

Parameters

mixed	$id
bool	$remember

Return Value

UserInterface

bool onceUsingId(mixed $id)

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

Parameters

mixed

$id

Return Value

bool

protected void queueRecallerCookie(UserInterface $user)

Отправить куки recaller в хранилище куки.

Parameters

UserInterface

$user

Return Value

void

protected Cookie createRecaller(string $value)

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

Parameters

string

$value

Return Value

void logout()

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

Return Value

void

protected void clearUserDataFromStorage()

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

Return Value

void

protected void refreshRememberToken(UserInterface $user)

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

Parameters

UserInterface

$user

Return Value

void

protected void createRememberTokenIfDoesntExist(UserInterface $user)

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

Parameters

UserInterface

$user

Return Value

void

CookieJar getCookieJar()

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

Return Value

CookieJar

Exceptions

RuntimeException

void setCookieJar(CookieJar $cookie)

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

Parameters

CookieJar

$cookie

Return Value

void

Dispatcher getDispatcher()

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

Return Value

Dispatcher

void setDispatcher(Dispatcher $events)

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

Parameters

Dispatcher

$events

Return Value

void

Store getSession()

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

Return Value

Store

UserProviderInterface getProvider()

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

Return Value

UserProviderInterface

void setProvider(UserProviderInterface $provider)

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

Parameters

UserProviderInterface

$provider

Return Value

void

UserInterface|null getUser()

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

Return Value

UserInterface|null

void setUser(UserInterface $user)

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

Parameters

UserInterface

$user

Return Value

void

Request getRequest()

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

Return Value

Request

$this setRequest(Request $request)

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

Parameters

Request

$request

Return Value

$this

UserInterface getLastAttempted()

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

Return Value

UserInterface

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